Class: Aws::AlexaForBusiness::Types::CreateBusinessReportScheduleRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::CreateBusinessReportScheduleRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
When making an API call, you may pass CreateBusinessReportScheduleRequest data as a 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
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
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.
A suitable default value is auto-generated. You should normally not need to pass this option.
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#content_range ⇒ Types::BusinessReportContentRange
The content range of the reports.
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#format ⇒ String
The format of the generated report (individual CSV files or zipped files of individual files).
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#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.
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#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.
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#s3_key_prefix ⇒ String
The S3 key where the report is delivered.
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#schedule_name ⇒ String
The name identifier of the schedule.
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The tags for the business report schedule.
829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 829 class CreateBusinessReportScheduleRequest < Struct.new( :schedule_name, :s3_bucket_name, :s3_key_prefix, :format, :content_range, :recurrence, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |