All Implemented Interfaces:

AWSPI

Direct Known Subclasses:

AbstractAWSPIAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSPI
extends Object
implements AWSPI 

• Field Summary

  • Fields inherited from interface com.amazonaws.services.pi.AWSPI

    ENDPOINT_PREFIX

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  CreatePerformanceAnalysisReportResult	createPerformanceAnalysisReport (CreatePerformanceAnalysisReportRequest request) Creates a new performance analysis report for a specific time period for the DB instance.
  DeletePerformanceAnalysisReportResult	deletePerformanceAnalysisReport (DeletePerformanceAnalysisReportRequest request) Deletes a performance analysis report.
  DescribeDimensionKeysResult	describeDimensionKeys (DescribeDimensionKeysRequest request) For a specific time period, retrieve the top N dimension keys for a metric.
  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.
  GetDimensionKeyDetailsResult	getDimensionKeyDetails (GetDimensionKeyDetailsRequest request) Get the attributes of the specified dimension group for a DB instance or data source.
  GetPerformanceAnalysisReportResult	getPerformanceAnalysisReport (GetPerformanceAnalysisReportRequest request) Retrieves the report including the report ID, status, time details, and the insights with recommendations.
  GetResourceMetadataResult	getResourceMetadata (GetResourceMetadataRequest request) Retrieve the metadata for different features.
  GetResourceMetricsResult	getResourceMetrics (GetResourceMetricsRequest request) Retrieve Performance Insights metrics for a set of data sources over a time period.
  ListAvailableResourceDimensionsResult	listAvailableResourceDimensions (ListAvailableResourceDimensionsRequest request) Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
  ListAvailableResourceMetricsResult	listAvailableResourceMetrics (ListAvailableResourceMetricsRequest request) Retrieve metrics of the specified types that can be queried for a specified DB instance.
  ListPerformanceAnalysisReportsResult	listPerformanceAnalysisReports (ListPerformanceAnalysisReportsRequest request) Lists all the analysis reports created for the DB instance.
  ListTagsForResourceResult	listTagsForResource (ListTagsForResourceRequest request) Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
  void	shutdown () Shuts down this client object, releasing any resources that might be held open.
  TagResourceResult	tagResource (TagResourceRequest request) Adds metadata tags to the Amazon RDS Performance Insights resource.
  UntagResourceResult	untagResource (UntagResourceRequest request) Deletes the metadata tags from the Amazon RDS Performance Insights resource.

  • Methods inherited from class java.lang.Object

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

• Method Detail

  • createPerformanceAnalysisReport

    public CreatePerformanceAnalysisReportResult createPerformanceAnalysisReport(CreatePerformanceAnalysisReportRequest request)

    Description copied from interface: AWSPI

    Creates a new performance analysis report for a specific time period for the DB instance.

    Specified by:

    createPerformanceAnalysisReport in interface AWSPI

    Returns:

    Result of the CreatePerformanceAnalysisReport operation returned by the service.

    See Also:

    AWS API Documentation

  • deletePerformanceAnalysisReport

    public DeletePerformanceAnalysisReportResult deletePerformanceAnalysisReport(DeletePerformanceAnalysisReportRequest request)

    Description copied from interface: AWSPI

    Deletes a performance analysis report.

    Specified by:

    deletePerformanceAnalysisReport in interface AWSPI

    Returns:

    Result of the DeletePerformanceAnalysisReport operation returned by the service.

    See Also:

    AWS API Documentation

  • describeDimensionKeys

    public DescribeDimensionKeysResult describeDimensionKeys(DescribeDimensionKeysRequest request)

    Description copied from interface: AWSPI

    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.

    Specified by:

    describeDimensionKeys in interface AWSPI

    Returns:

    Result of the DescribeDimensionKeys operation returned by the service.

    See Also:

    AWS API Documentation

  • getDimensionKeyDetails

    public GetDimensionKeyDetailsResult getDimensionKeyDetails(GetDimensionKeyDetailsRequest request)

    Description copied from interface: AWSPI

    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.

    Specified by:

    getDimensionKeyDetails in interface AWSPI

    Returns:

    Result of the GetDimensionKeyDetails operation returned by the service.

    See Also:

    AWS API Documentation

  • getPerformanceAnalysisReport

    public GetPerformanceAnalysisReportResult getPerformanceAnalysisReport(GetPerformanceAnalysisReportRequest request)

    Description copied from interface: AWSPI

    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.

    Specified by:

    getPerformanceAnalysisReport in interface AWSPI

    Returns:

    Result of the GetPerformanceAnalysisReport operation returned by the service.

    See Also:

    AWS API Documentation

  • getResourceMetadata

    public GetResourceMetadataResult getResourceMetadata(GetResourceMetadataRequest request)

    Description copied from interface: AWSPI

    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.

    Specified by:

    getResourceMetadata in interface AWSPI

    Returns:

    Result of the GetResourceMetadata operation returned by the service.

    See Also:

    AWS API Documentation

  • getResourceMetrics

    public GetResourceMetricsResult getResourceMetrics(GetResourceMetricsRequest request)

    Description copied from interface: AWSPI

    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.

    Specified by:

    getResourceMetrics in interface AWSPI

    Returns:

    Result of the GetResourceMetrics operation returned by the service.

    See Also:

    AWS API Documentation

  • listAvailableResourceDimensions

    public ListAvailableResourceDimensionsResult listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest request)

    Description copied from interface: AWSPI

    Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

    Specified by:

    listAvailableResourceDimensions in interface AWSPI

    Returns:

    Result of the ListAvailableResourceDimensions operation returned by the service.

    See Also:

    AWS API Documentation

  • listAvailableResourceMetrics

    public ListAvailableResourceMetricsResult listAvailableResourceMetrics(ListAvailableResourceMetricsRequest request)

    Description copied from interface: AWSPI

    Retrieve metrics of the specified types that can be queried for a specified DB instance.

    Specified by:

    listAvailableResourceMetrics in interface AWSPI

    Returns:

    Result of the ListAvailableResourceMetrics operation returned by the service.

    See Also:

    AWS API Documentation

  • listPerformanceAnalysisReports

    public ListPerformanceAnalysisReportsResult listPerformanceAnalysisReports(ListPerformanceAnalysisReportsRequest request)

    Description copied from interface: AWSPI

    Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

    Specified by:

    listPerformanceAnalysisReports in interface AWSPI

    Returns:

    Result of the ListPerformanceAnalysisReports operation returned by the service.

    See Also:

    AWS API Documentation

  • listTagsForResource

    public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

    Description copied from interface: AWSPI

    Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

    Specified by:

    listTagsForResource in interface AWSPI

    Returns:

    Result of the ListTagsForResource operation returned by the service.

    See Also:

    AWS API Documentation

  • tagResource

    public TagResourceResult tagResource(TagResourceRequest request)

    Description copied from interface: AWSPI

    Adds metadata tags to the Amazon RDS Performance Insights resource.

    Specified by:

    tagResource in interface AWSPI

    Returns:

    Result of the TagResource operation returned by the service.

    See Also:

    AWS API Documentation

  • untagResource

    public UntagResourceResult untagResource(UntagResourceRequest request)

    Description copied from interface: AWSPI

    Deletes the metadata tags from the Amazon RDS Performance Insights resource.

    Specified by:

    untagResource in interface AWSPI

    Returns:

    Result of the UntagResource operation returned by the service.

    See Also:

    AWS API Documentation

  • shutdown

    public void shutdown()

    Description copied from interface: AWSPI
    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.

    Specified by:

    shutdown in interface AWSPI

  • getCachedResponseMetadata

    public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

    Description copied from interface: AWSPI
    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.

    Specified by:

    getCachedResponseMetadata in interface AWSPI

    Parameters:

    request - The originally executed request.

    Returns:

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