performance_analysis_reports

Creates, updates, deletes, gets or lists a performance_analysis_reports resource.

Overview

Name	performance_analysis_reports
Type	Resource
Id	aws.pi.performance_analysis_reports

Fields

The following fields are returned by SELECT queries:

get_performance_analysis_report

Name	Datatype	Description
analysis_report_id	string	The name of the analysis report. (pattern: <code>report-[0-9a-f]{17}</code>)
create_time	string (date-time)	The time you created the analysis report.
end_time	string (date-time)	The analysis end time in the report.
identifier	string	The unique identifier of the analysis report. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
insights	array	The list of identified insights in the analysis report.
service_type	string	List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows: RDS DOCDB (RDS, DOCDB)
start_time	string (date-time)	The analysis start time in the report.
status	string	The status of the created analysis report. (RUNNING, SUCCEEDED, FAILED)

list_performance_analysis_reports

Name	Datatype	Description
analysis_reports	array	List of reports including the report identifier, start and end time, creation time, and status.
next_token	string	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults. (pattern: <code>^[a-zA-Z0-9_=-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_performance_analysis_report	select	region		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.
list_performance_analysis_reports	select	region		Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
create_performance_analysis_report	insert	region, ServiceType, Identifier, StartTime		Creates a new performance analysis report for a specific time period for the DB instance.
delete_performance_analysis_report	delete	region		Deletes a performance analysis report.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_performance_analysis_report

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.

SELECT
analysis_report_id,
create_time,
end_time,
identifier,
insights,
service_type,
start_time,
status
FROM aws.pi.performance_analysis_reports
WHERE region = '{{ region }}' -- required
;

list_performance_analysis_reports

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

SELECT
analysis_reports,
next_token
FROM aws.pi.performance_analysis_reports
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_performance_analysis_report

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

INSERT INTO aws.pi.performance_analysis_reports (
ServiceType,
Identifier,
StartTime,
EndTime,
Tags,
region
)
SELECT 
'{{ ServiceType }}' /* required */,
'{{ Identifier }}' /* required */,
'{{ StartTime }}' /* required */,
'{{ EndTime }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
analysis_report_id
;

Manifest

# Description fields are for documentation purposes
- name: performance_analysis_reports
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the performance_analysis_reports resource.
  - name: ServiceType
    value: "{{ ServiceType }}"
    description: |
      The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
    valid_values: ['RDS', 'DOCDB']
  - name: Identifier
    value: "{{ Identifier }}"
    description: |
      An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.
  - name: StartTime
    value: "{{ StartTime }}"
    description: |
      The start time defined for the analysis report.
  - name: EndTime
    value: "{{ EndTime }}"
    description: |
      The end time defined for the analysis report.
  - name: Tags
    description: |
      The metadata assigned to the analysis report consisting of a key-value pair.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_performance_analysis_report

Deletes a performance analysis report.

DELETE FROM aws.pi.performance_analysis_reports
WHERE region = '{{ region }}' --required
;