AlexaForBusiness / Client / update_business_report_schedule

update_business_report_schedule#

AlexaForBusiness.Client.update_business_report_schedule(**kwargs)#

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

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.update_business_report_schedule(
    ScheduleArn='string',
    S3BucketName='string',
    S3KeyPrefix='string',
    Format='CSV'|'CSV_ZIP',
    ScheduleName='string',
    Recurrence={
        'StartDate': 'string'
    }
)
Parameters:

  • ScheduleArn (string) –

    [REQUIRED]

    The ARN of the business report schedule.

  • S3BucketName (string) – The S3 location 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).

  • ScheduleName (string) – The name identifier of the schedule.

  • Recurrence (dict) –

    The recurrence of the reports.

    • StartDate (string) –

      The start date.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException