You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AlexaForBusiness::Types::CreateBusinessReportScheduleRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateBusinessReportScheduleRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  schedule_name: "BusinessReportScheduleName",
  s3_bucket_name: "CustomerS3BucketName",
  s3_key_prefix: "S3KeyPrefix",
  format: "CSV", # required, accepts CSV, CSV_ZIP
  content_range: { # required
    interval: "ONE_DAY", # accepts ONE_DAY, ONE_WEEK, THIRTY_DAYS
  },
  recurrence: {
    start_date: "Date",
  },
  client_request_token: "ClientRequestToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

The client request token.

Returns:

  • (String)

    The client request token.

#content_rangeTypes::BusinessReportContentRange

The content range of the reports.

Returns:

#formatString

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

Possible values:

  • CSV
  • CSV_ZIP

Returns:

  • (String)

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

#recurrenceTypes::BusinessReportRecurrence

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

Returns:

#s3_bucket_nameString

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.

Returns:

  • (String)

    The S3 bucket name of the output reports.

#s3_key_prefixString

The S3 key where the report is delivered.

Returns:

  • (String)

    The S3 key where the report is delivered.

#schedule_nameString

The name identifier of the schedule.

Returns:

  • (String)

    The name identifier of the schedule.