com.amazonaws.services.codeguruprofiler

Interface AmazonCodeGuruProfiler

All Known Subinterfaces:

AmazonCodeGuruProfilerAsync

All Known Implementing Classes:

AbstractAmazonCodeGuruProfiler, AbstractAmazonCodeGuruProfilerAsync, AmazonCodeGuruProfilerAsyncClient, AmazonCodeGuruProfilerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCodeGuruProfiler

Interface for accessing Amazon CodeGuru Profiler.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCodeGuruProfiler instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ConfigureAgentResult	configureAgent(ConfigureAgentRequest configureAgentRequest)
CreateProfilingGroupResult	createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest) Creates a profiling group.
DeleteProfilingGroupResult	deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest) Deletes a profiling group.
DescribeProfilingGroupResult	describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest) 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 getPolicyRequest) Gets the profiling group policy.
GetProfileResult	getProfile(GetProfileRequest getProfileRequest) Gets the aggregated profile of a profiling group for the specified time range.
ListProfileTimesResult	listProfileTimes(ListProfileTimesRequest listProfileTimesRequest) 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 listProfilingGroupsRequest) Lists profiling groups.
PostAgentProfileResult	postAgentProfile(PostAgentProfileRequest postAgentProfileRequest)
PutPermissionResult	putPermission(PutPermissionRequest putPermissionRequest) Provides permission to the principals.
RemovePermissionResult	removePermission(RemovePermissionRequest removePermissionRequest) Removes statement for the provided action group from the policy.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateProfilingGroupResult	updateProfilingGroup(UpdateProfilingGroupRequest updateProfilingGroupRequest) Updates a profiling group.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

configureAgent

ConfigureAgentResult configureAgent(ConfigureAgentRequest configureAgentRequest)

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

CreateProfilingGroupResult createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest)

Creates a profiling group.

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

DeleteProfilingGroupResult deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest)

Deletes a profiling group.

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

DescribeProfilingGroupResult describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest)

Describes a profiling group.

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

GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)

Gets the profiling group policy.

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

GetProfileResult getProfile(GetProfileRequest getProfileRequest)

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.

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

ListProfileTimesResult listProfileTimes(ListProfileTimesRequest listProfileTimesRequest)

List 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.

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

ListProfilingGroupsResult listProfilingGroups(ListProfilingGroupsRequest listProfilingGroupsRequest)

Lists profiling groups.

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

PostAgentProfileResult postAgentProfile(PostAgentProfileRequest postAgentProfileRequest)

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

PutPermissionResult putPermission(PutPermissionRequest putPermissionRequest)

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

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

RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest)

Removes statement for the provided action group from the policy.

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

UpdateProfilingGroupResult updateProfilingGroup(UpdateProfilingGroupRequest updateProfilingGroupRequest)

Updates a profiling group.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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