AlexaForBusiness / Paginator / ListBusinessReportSchedules

ListBusinessReportSchedules

class AlexaForBusiness.Paginator.ListBusinessReportSchedules

paginator = client.get_paginator('list_business_report_schedules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_business_report_schedules().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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

{
    'BusinessReportSchedules': [
        {
            'ScheduleArn': 'string',
            'ScheduleName': 'string',
            'S3BucketName': 'string',
            'S3KeyPrefix': 'string',
            'Format': 'CSV'|'CSV_ZIP',
            'ContentRange': {
                'Interval': 'ONE_DAY'|'ONE_WEEK'|'THIRTY_DAYS'
            },
            'Recurrence': {
                'StartDate': 'string'
            },
            'LastBusinessReport': {
                'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
                'FailureCode': 'ACCESS_DENIED'|'NO_SUCH_BUCKET'|'INTERNAL_FAILURE',
                'S3Location': {
                    'Path': 'string',
                    'BucketName': 'string'
                },
                'DeliveryTime': datetime(2015, 1, 1),
                'DownloadUrl': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • BusinessReportSchedules (list) –

    The schedule of the reports.

    • (dict) –

      The schedule of the usage report.

      • ScheduleArn (string) –

        The ARN of the business report schedule.

      • ScheduleName (string) –

        The name identifier of the schedule.

      • S3BucketName (string) –

        The S3 bucket name of the output reports.

      • S3KeyPrefix (string) –

        The S3 key where the report is delivered.

      • Format (string) –

        The format of the generated report (individual CSV files or zipped files of individual files).

      • ContentRange (dict) –

        The content range of the reports.

        • Interval (string) –

          The interval of the content range.

      • Recurrence (dict) –

        The recurrence of the reports.

        • StartDate (string) –

          The start date.

      • LastBusinessReport (dict) –

        The details of the last business report delivery for a specified time interval.

        • Status (string) –

          The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

        • FailureCode (string) –

          The failure code.

        • S3Location (dict) –

          The S3 location of the output reports.

          • Path (string) –

            The path of the business report.

          • BucketName (string) –

            The S3 bucket name of the output reports.

        • DeliveryTime (datetime) –

          The time of report delivery.

        • DownloadUrl (string) –

          The download link where a user can download the report.