AlexaForBusiness / Client / list_business_report_schedules

list_business_report_schedules

AlexaForBusiness.Client.list_business_report_schedules(**kwargs)

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

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 = client.list_business_report_schedules(
    NextToken='string',
    MaxResults=123
)

Parameters:

• NextToken (string) – The token used to list the remaining schedules from the previous API call.

• MaxResults (integer) – The maximum number of schedules listed in the call.

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'
            }
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    The token used to list the remaining schedules from the previous API call.