PI / Client / create_performance_analysis_report

create_performance_analysis_report#

PI.Client.create_performance_analysis_report(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_performance_analysis_report(
    ServiceType='RDS'|'DOCDB',
    Identifier='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ServiceType (string) –

    [REQUIRED]

    The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

  • Identifier (string) –

    [REQUIRED]

    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.

  • StartTime (datetime) –

    [REQUIRED]

    The start time defined for the analysis report.

  • EndTime (datetime) –

    [REQUIRED]

    The end time defined for the analysis report.

  • Tags (list) –

    The metadata assigned to the analysis report consisting of a key-value pair.

    • (dict) –

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      • Key (string) – [REQUIRED]

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

      • Value (string) – [REQUIRED]

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Return type:

dict

Returns:

Response Syntax

{
    'AnalysisReportId': 'string'
}

Response Structure

  • (dict) –

    • AnalysisReportId (string) –

      A unique identifier for the created analysis report.

Exceptions

  • PI.Client.exceptions.InvalidArgumentException

  • PI.Client.exceptions.InternalServiceError

  • PI.Client.exceptions.NotAuthorizedException