com.amazonaws.services.pi.AWSPI Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pi Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.pi;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.pi.model.*;
/**
* Interface for accessing AWS PI.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.pi.AbstractAWSPI} instead.
*
*
* Amazon RDS Performance Insights
*
* Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on
* data captured from a running DB instance. The guide provides detailed information about Performance Insights data
* types, parameters and errors.
*
*
* When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the
* performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services
* service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
*
*
* DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a
* two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time
* range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point.
* Examples include SQL, Wait event, User, and Host.
*
*
* -
*
* To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User
* Guide .
*
*
* -
*
* To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
*
*
* -
*
* To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB
* Developer Guide .
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSPI {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "pi";
/**
*
* Creates a new performance analysis report for a specific time period for the DB instance.
*
*
* @param createPerformanceAnalysisReportRequest
* @return Result of the CreatePerformanceAnalysisReport operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.CreatePerformanceAnalysisReport
* @see AWS API Documentation
*/
CreatePerformanceAnalysisReportResult createPerformanceAnalysisReport(CreatePerformanceAnalysisReportRequest createPerformanceAnalysisReportRequest);
/**
*
* Deletes a performance analysis report.
*
*
* @param deletePerformanceAnalysisReportRequest
* @return Result of the DeletePerformanceAnalysisReport operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.DeletePerformanceAnalysisReport
* @see AWS API Documentation
*/
DeletePerformanceAnalysisReportResult deletePerformanceAnalysisReport(DeletePerformanceAnalysisReportRequest deletePerformanceAnalysisReportRequest);
/**
*
* For a specific time period, retrieve the top N dimension keys for a metric.
*
*
*
* Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first
* 500 bytes are returned.
*
*
*
* @param describeDimensionKeysRequest
* @return Result of the DescribeDimensionKeys operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.DescribeDimensionKeys
* @see AWS API
* Documentation
*/
DescribeDimensionKeysResult describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest);
/**
*
* Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify
* a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension
* db.sql.statement associated with this ID. This operation is useful because
* GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL
* statement text.
*
*
* @param getDimensionKeyDetailsRequest
* @return Result of the GetDimensionKeyDetails operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.GetDimensionKeyDetails
* @see AWS API
* Documentation
*/
GetDimensionKeyDetailsResult getDimensionKeyDetails(GetDimensionKeyDetailsRequest getDimensionKeyDetailsRequest);
/**
*
* Retrieves the report including the report ID, status, time details, and the insights with recommendations. The
* report status can be RUNNING, SUCCEEDED, or FAILED. The insights include
* the description and recommendation fields.
*
*
* @param getPerformanceAnalysisReportRequest
* @return Result of the GetPerformanceAnalysisReport operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.GetPerformanceAnalysisReport
* @see AWS API Documentation
*/
GetPerformanceAnalysisReportResult getPerformanceAnalysisReport(GetPerformanceAnalysisReportRequest getPerformanceAnalysisReportRequest);
/**
*
* Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned
* on or off on a specific DB instance.
*
*
* @param getResourceMetadataRequest
* @return Result of the GetResourceMetadata operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.GetResourceMetadata
* @see AWS API
* Documentation
*/
GetResourceMetadataResult getResourceMetadata(GetResourceMetadataRequest getResourceMetadataRequest);
/**
*
* Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific
* dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate
* function for each metric.
*
*
*
* Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first
* 500 bytes are returned.
*
*
*
* @param getResourceMetricsRequest
* @return Result of the GetResourceMetrics operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.GetResourceMetrics
* @see AWS API
* Documentation
*/
GetResourceMetricsResult getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest);
/**
*
* Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
*
*
* @param listAvailableResourceDimensionsRequest
* @return Result of the ListAvailableResourceDimensions operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.ListAvailableResourceDimensions
* @see AWS API Documentation
*/
ListAvailableResourceDimensionsResult listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest);
/**
*
* Retrieve metrics of the specified types that can be queried for a specified DB instance.
*
*
* @param listAvailableResourceMetricsRequest
* @return Result of the ListAvailableResourceMetrics operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.ListAvailableResourceMetrics
* @see AWS API Documentation
*/
ListAvailableResourceMetricsResult listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest);
/**
*
* Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of
* each report.
*
*
* @param listPerformanceAnalysisReportsRequest
* @return Result of the ListPerformanceAnalysisReports operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.ListPerformanceAnalysisReports
* @see AWS API Documentation
*/
ListPerformanceAnalysisReportsResult listPerformanceAnalysisReports(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest);
/**
*
* Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Adds metadata tags to the Amazon RDS Performance Insights resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Deletes the metadata tags from the Amazon RDS Performance Insights resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InvalidArgumentException
* One of the arguments provided is invalid for this request.
* @throws InternalServiceErrorException
* The request failed due to an unknown error.
* @throws NotAuthorizedException
* The user is not authorized to perform this request.
* @sample AWSPI.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}