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.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddNotificationChannelsResult	addNotificationChannels(AddNotificationChannelsRequest addNotificationChannelsRequest) Add up to 2 anomaly notifications channels for a profiling group.
BatchGetFrameMetricDataResult	batchGetFrameMetricData(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest) Returns the time series of values for a requested list of frame metrics from a time period.
ConfigureAgentResult	configureAgent(ConfigureAgentRequest configureAgentRequest) Used by profiler agents to report their current state and to receive remote configuration updates.
CreateProfilingGroupResult	createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest) Creates a profiling group.
DeleteProfilingGroupResult	deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest) Deletes a profiling group.
DescribeProfilingGroupResult	describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest) Returns a ProfilingGroupDescription object that contains information about the requested 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.
GetFindingsReportAccountSummaryResult	getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest) Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
GetNotificationConfigurationResult	getNotificationConfiguration(GetNotificationConfigurationRequest getNotificationConfigurationRequest) Get the current configuration for anomaly notifications for a profiling group.
GetPolicyResult	getPolicy(GetPolicyRequest getPolicyRequest) Returns the JSON-formatted resource-based policy on a profiling group.
GetProfileResult	getProfile(GetProfileRequest getProfileRequest) Gets the aggregated profile of a profiling group for a specified time range.
GetRecommendationsResult	getRecommendations(GetRecommendationsRequest getRecommendationsRequest) Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period.
ListFindingsReportsResult	listFindingsReports(ListFindingsReportsRequest listFindingsReportsRequest) List the available reports for a given profiling group and time range.
ListProfileTimesResult	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.
ListProfilingGroupsResult	listProfilingGroups(ListProfilingGroupsRequest listProfilingGroupsRequest) Returns a list of profiling groups.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags that are assigned to a specified resource.
PostAgentProfileResult	postAgentProfile(PostAgentProfileRequest postAgentProfileRequest) Submits profiling data to an aggregated profile of a profiling group.
PutPermissionResult	putPermission(PutPermissionRequest putPermissionRequest) Adds permissions to a profiling group's resource-based policy that are provided using an action group.
RemoveNotificationChannelResult	removeNotificationChannel(RemoveNotificationChannelRequest removeNotificationChannelRequest) Remove one anomaly notifications channel for a profiling group.
RemovePermissionResult	removePermission(RemovePermissionRequest removePermissionRequest) Removes permissions from a profiling group's resource-based policy that are provided using an action group.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SubmitFeedbackResult	submitFeedback(SubmitFeedbackRequest submitFeedbackRequest) Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Use to assign one or more tags to a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Use to remove one or more tags from a resource.
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

addNotificationChannels

AddNotificationChannelsResult addNotificationChannels(AddNotificationChannelsRequest addNotificationChannelsRequest)

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.

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.

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

See Also:

AWS API Documentation

batchGetFrameMetricData

BatchGetFrameMetricDataResult batchGetFrameMetricData(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest)

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.

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

configureAgent

ConfigureAgentResult configureAgent(ConfigureAgentRequest configureAgentRequest)

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.

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.

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

describeProfilingGroup

DescribeProfilingGroupResult describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest)

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.

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

getFindingsReportAccountSummary

GetFindingsReportAccountSummaryResult getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest)

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.

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.

See Also:

AWS API Documentation

getNotificationConfiguration

GetNotificationConfigurationResult getNotificationConfiguration(GetNotificationConfigurationRequest getNotificationConfigurationRequest)

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.

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)

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.

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

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

getRecommendations

GetRecommendationsResult getRecommendations(GetRecommendationsRequest getRecommendationsRequest)

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.

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

listFindingsReports

ListFindingsReportsResult listFindingsReports(ListFindingsReportsRequest listFindingsReportsRequest)

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.

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)

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.

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)

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.

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

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

Throws:

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

ValidationException - The parameter is not valid.

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

See Also:

AWS API Documentation

postAgentProfile

PostAgentProfileResult postAgentProfile(PostAgentProfileRequest postAgentProfileRequest)

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.

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)

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.

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

removeNotificationChannel

RemoveNotificationChannelResult removeNotificationChannel(RemoveNotificationChannelRequest removeNotificationChannelRequest)

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.

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

removePermission

RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest)

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.

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

submitFeedback

SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)

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.

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

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Use to assign one or more tags to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource 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.

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

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Use to remove one or more tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource 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.

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.