Alexa For Business

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

See also: AWS API Documentation

Request Syntax

client.create_business_report_schedule(
    ScheduleName='string',
    S3BucketName='string',
    S3KeyPrefix='string',
    Format='CSV'|'CSV_ZIP',
    ContentRange={
        'Interval': 'ONE_DAY'|'ONE_WEEK'
    },
    Recurrence={
        'StartDate': 'string'
    },
    ClientRequestToken='string'
)

type ScheduleName:

string

param ScheduleName:

The name identifier of the schedule.

type S3BucketName:

string

param S3BucketName:

The S3 bucket name of the output reports.

type S3KeyPrefix:

string

param S3KeyPrefix:

The S3 key where the report is delivered.

type Format:

string

param Format:

[REQUIRED]

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

type ContentRange:

dict

param ContentRange:

[REQUIRED]

The content range of the reports.

• Interval (string) --

  The interval of the content range.

type Recurrence:

dict

param Recurrence:

The recurrence of the reports.

• StartDate (string) --

  The start date.

type ClientRequestToken:

string

param ClientRequestToken:

The client request token.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'ScheduleArn': 'string'
}

Response Structure

• (dict) --

  • ScheduleArn (string) --

    The ARN of the business report schedule.

Deletes the recurring report delivery schedule with the specified schedule ARN.

See also: AWS API Documentation

Request Syntax

client.delete_business_report_schedule(
    ScheduleArn='string'
)

type ScheduleArn:

string

param ScheduleArn:

[REQUIRED]

The ARN of the business report schedule.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates the configuration of the report delivery schedule with the specified schedule ARN.

See also: AWS API Documentation

Request Syntax

client.update_business_report_schedule(
    ScheduleArn='string',
    S3BucketName='string',
    S3KeyPrefix='string',
    Format='CSV'|'CSV_ZIP',
    ScheduleName='string',
    Recurrence={
        'StartDate': 'string'
    }
)

type ScheduleArn:

string

param ScheduleArn:

[REQUIRED]

The ARN of the business report schedule.

type S3BucketName:

string

param S3BucketName:

The S3 location of the output reports.

type S3KeyPrefix:

string

param S3KeyPrefix:

The S3 key where the report is delivered.

type Format:

string

param Format:

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

type ScheduleName:

string

param ScheduleName:

The name identifier of the schedule.

type Recurrence:

dict

param Recurrence:

The recurrence of the reports.

• StartDate (string) --

  The start date.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists the details of the schedules that a user configured.

See also: AWS API Documentation

Request Syntax

client.list_business_report_schedules(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of schedules listed in the call.

rtype:

dict

returns:

Response Syntax

{
    'BusinessReportSchedules': [
        {
            'ScheduleArn': 'string',
            'ScheduleName': 'string',
            'S3BucketName': 'string',
            'S3KeyPrefix': 'string',
            'Format': 'CSV'|'CSV_ZIP',
            'ContentRange': {
                'Interval': 'ONE_DAY'|'ONE_WEEK'
            },
            '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.