ApplicationCostProfiler / Paginator / ListReportDefinitions

ListReportDefinitions

class ApplicationCostProfiler.Paginator.ListReportDefinitions

paginator = client.get_paginator('list_report_definitions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApplicationCostProfiler.Client.list_report_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.