AlexaForBusiness / Client / create_business_report_schedule

create_business_report_schedule#

AlexaForBusiness.Client.create_business_report_schedule(**kwargs)#

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

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.create_business_report_schedule(
    ScheduleName='string',
    S3BucketName='string',
    S3KeyPrefix='string',
    Format='CSV'|'CSV_ZIP',
    ContentRange={
        'Interval': 'ONE_DAY'|'ONE_WEEK'|'THIRTY_DAYS'
    },
    Recurrence={
        'StartDate': 'string'
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

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

  • S3BucketName (string) – The S3 bucket name of the output reports. If this isn’t specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

  • S3KeyPrefix (string) – The S3 key where the report is delivered.

  • Format (string) –

    [REQUIRED]

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

  • ContentRange (dict) –

    [REQUIRED]

    The content range of the reports.

    • Interval (string) – [REQUIRED]

      The interval of the content range.

  • Recurrence (dict) –

    The recurrence of the reports. If this isn’t specified, the report will only be delivered one time when the API is called.

    • StartDate (string) –

      The start date.

  • ClientRequestToken (string) –

    The client request token.

    This field is autopopulated if not provided.

  • Tags (list) –

    The tags for the business report schedule.

    • (dict) –

      A key-value pair that can be associated with a resource.

      • Key (string) – [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) – [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'ScheduleArn': 'string'
}

Response Structure

  • (dict) –

    • ScheduleArn (string) –

      The ARN of the business report schedule.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException