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

Class: Aws::AlexaForBusiness::Types::UpdateBusinessReportScheduleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

When making an API call, you may pass UpdateBusinessReportScheduleRequest data as a hash:

{
  schedule_arn: "Arn", # required
  s3_bucket_name: "CustomerS3BucketName",
  s3_key_prefix: "S3KeyPrefix",
  format: "CSV", # accepts CSV, CSV_ZIP
  schedule_name: "BusinessReportScheduleName",
  recurrence: {
    start_date: "Date",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#formatString

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

Returns:

  • (String)


5296
5297
5298
5299
5300
5301
5302
5303
5304
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5296

class UpdateBusinessReportScheduleRequest < Struct.new(
  :schedule_arn,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :schedule_name,
  :recurrence)
  include Aws::Structure
end

#recurrenceTypes::BusinessReportRecurrence

The recurrence of the reports.



5296
5297
5298
5299
5300
5301
5302
5303
5304
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5296

class UpdateBusinessReportScheduleRequest < Struct.new(
  :schedule_arn,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :schedule_name,
  :recurrence)
  include Aws::Structure
end

#s3_bucket_nameString

The S3 location of the output reports.

Returns:

  • (String)


5296
5297
5298
5299
5300
5301
5302
5303
5304
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5296

class UpdateBusinessReportScheduleRequest < Struct.new(
  :schedule_arn,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :schedule_name,
  :recurrence)
  include Aws::Structure
end

#s3_key_prefixString

The S3 key where the report is delivered.

Returns:

  • (String)


5296
5297
5298
5299
5300
5301
5302
5303
5304
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5296

class UpdateBusinessReportScheduleRequest < Struct.new(
  :schedule_arn,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :schedule_name,
  :recurrence)
  include Aws::Structure
end

#schedule_arnString

The ARN of the business report schedule.

Returns:

  • (String)


5296
5297
5298
5299
5300
5301
5302
5303
5304
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5296

class UpdateBusinessReportScheduleRequest < Struct.new(
  :schedule_arn,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :schedule_name,
  :recurrence)
  include Aws::Structure
end

#schedule_nameString

The name identifier of the schedule.

Returns:

  • (String)


5296
5297
5298
5299
5300
5301
5302
5303
5304
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5296

class UpdateBusinessReportScheduleRequest < Struct.new(
  :schedule_arn,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :schedule_name,
  :recurrence)
  include Aws::Structure
end