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
- Struct
- Aws::AlexaForBusiness::Types::CreateBusinessReportScheduleRequest
- Defined in:
- (unknown)
Overview
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", # required, accepts ONE_DAY, ONE_WEEK, THIRTY_DAYS
},
recurrence: {
start_date: "Date",
},
client_request_token: "ClientRequestToken",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
The client request token.
-
#content_range ⇒ Types::BusinessReportContentRange
The content range of the reports.
-
#format ⇒ String
The format of the generated report (individual CSV files or zipped files of individual files).
-
#recurrence ⇒ Types::BusinessReportRecurrence
The recurrence of the reports.
-
#s3_bucket_name ⇒ String
The S3 bucket name of the output reports.
-
#s3_key_prefix ⇒ String
The S3 key where the report is delivered.
-
#schedule_name ⇒ String
The name identifier of the schedule.
-
#tags ⇒ Array<Types::Tag>
The tags for the business report schedule.
Instance Attribute Details
#client_request_token ⇒ String
The client request token.
#content_range ⇒ Types::BusinessReportContentRange
The content range of the reports.
#format ⇒ String
The format of the generated report (individual CSV files or zipped files of individual files).
Possible values:
- CSV
- CSV_ZIP
#recurrence ⇒ Types::BusinessReportRecurrence
The recurrence of the reports. If this isn\'t specified, the report will only be delivered one time when the API is called.
#s3_bucket_name ⇒ 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.
#s3_key_prefix ⇒ String
The S3 key where the report is delivered.
#schedule_name ⇒ String
The name identifier of the schedule.
#tags ⇒ Array<Types::Tag>
The tags for the business report schedule.