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.

Example service documentation.

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) Provides the configuration to use for an agent of the profiling group.
CreateProfilingGroupResult	createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest) Create a profiling group.
DeleteProfilingGroupResult	deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest) Delete a profiling group.
DescribeProfilingGroupResult	describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest) Describe 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.
GetProfileResult	getProfile(GetProfileRequest getProfileRequest) Get 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) List profiling groups in the account.
PostAgentProfileResult	postAgentProfile(PostAgentProfileRequest postAgentProfileRequest) Submit profile collected by an agent belonging to a profiling group for aggregation.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateProfilingGroupResult	updateProfilingGroup(UpdateProfilingGroupRequest updateProfilingGroupRequest) Update 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)

Provides the configuration to use for an agent of the profiling group.

Parameters:

configureAgentRequest - Request for ConfigureAgent operation.

Returns:

Result of the ConfigureAgent operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which does not exist.

See Also:

AWS API Documentation

createProfilingGroup

CreateProfilingGroupResult createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest)

Create a profiling group.

Parameters:

createProfilingGroupRequest - Request for CreateProfilingGroup operation.

Returns:

Result of the CreateProfilingGroup operation returned by the service.

Throws:

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

InternalServerException - Unexpected error during processing of request.

ConflictException - Request can can cause an inconsistent state for the resource.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

deleteProfilingGroup

DeleteProfilingGroupResult deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest)

Delete a profiling group.

Parameters:

deleteProfilingGroupRequest - Request for DeleteProfilingGroup operation.

Returns:

Result of the DeleteProfilingGroup operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which does not exist.

See Also:

AWS API Documentation

describeProfilingGroup

DescribeProfilingGroupResult describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest)

Describe a profiling group.

Parameters:

describeProfilingGroupRequest - Request for DescribeProfilingGroup operation.

Returns:

Result of the DescribeProfilingGroup operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which does not exist.

See Also:

AWS API Documentation

getProfile

GetProfileResult getProfile(GetProfileRequest getProfileRequest)

Get 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 will be 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 instance, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, then the returned profile will be from 00:15 to 00:20.

Parameters:

getProfileRequest - Request for GetProfile operation.

Returns:

Result of the GetProfile operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which 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 - Request for ListProfileTimes operation.

Returns:

Result of the ListProfileTimes operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which does not exist.

See Also:

AWS API Documentation

listProfilingGroups

ListProfilingGroupsResult listProfilingGroups(ListProfilingGroupsRequest listProfilingGroupsRequest)

List profiling groups in the account.

Parameters:

listProfilingGroupsRequest - Request for ListProfilingGroups operation.

Returns:

Result of the ListProfilingGroups operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ThrottlingException - Request was denied due to request throttling.

See Also:

AWS API Documentation

postAgentProfile

PostAgentProfileResult postAgentProfile(PostAgentProfileRequest postAgentProfileRequest)

Submit profile collected by an agent belonging to a profiling group for aggregation.

Parameters:

postAgentProfileRequest - Request for PostAgentProfile operation.

Returns:

Result of the PostAgentProfile operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which does not exist.

See Also:

AWS API Documentation

updateProfilingGroup

UpdateProfilingGroupResult updateProfilingGroup(UpdateProfilingGroupRequest updateProfilingGroupRequest)

Update a profiling group.

Parameters:

updateProfilingGroupRequest - Request for UpdateProfilingGroup operation.

Returns:

Result of the UpdateProfilingGroup operation returned by the service.

Throws:

InternalServerException - Unexpected error during processing of request.

ConflictException - Request can can cause an inconsistent state for the resource.

ValidationException - The input fails to satisfy the constraints of the API.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which 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.