ApplicationCostProfiler / Client / list_report_definitions

list_report_definitions#

ApplicationCostProfiler.Client.list_report_definitions(**kwargs)#

Retrieves a list of all reports and their configurations for your AWS account.

The maximum number of reports is one.

See also: AWS API Documentation

Request Syntax

response = client.list_report_definitions(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token value from a previous call to access the next page of results.

  • maxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'reportDefinitions': [
        {
            'reportId': 'string',
            'reportDescription': 'string',
            'reportFrequency': 'MONTHLY'|'DAILY'|'ALL',
            'format': 'CSV'|'PARQUET',
            'destinationS3Location': {
                'bucket': 'string',
                'prefix': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • reportDefinitions (list) –

      The retrieved reports.

      • (dict) –

        The configuration of a report in AWS Application Cost Profiler.

        • reportId (string) –

          The ID of the report.

        • reportDescription (string) –

          Description of the report

        • reportFrequency (string) –

          The cadence at which the report is generated.

        • format (string) –

          The format used for the generated reports.

        • destinationS3Location (dict) –

          The location in Amazon Simple Storage Service (Amazon S3) the reports should be saved to.

          • bucket (string) –

            Name of the S3 bucket.

          • prefix (string) –

            Prefix for the location to write to.

        • createdAt (datetime) –

          Timestamp (milliseconds) when this report definition was created.

        • lastUpdatedAt (datetime) –

          Timestamp (milliseconds) when this report definition was last updated.

    • nextToken (string) –

      The value of the next token, if it exists. Null if there are no more results.

Exceptions