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

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

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 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", # accepts ONE_DAY, ONE_WEEK
  },
  recurrence: {
    start_date: "Date",
  },
  client_request_token: "ClientRequestToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

The client request token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 780

class CreateBusinessReportScheduleRequest < Struct.new(
  :schedule_name,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :content_range,
  :recurrence,
  :client_request_token)
  include Aws::Structure
end

#content_rangeTypes::BusinessReportContentRange

The content range of the reports.



780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 780

class CreateBusinessReportScheduleRequest < Struct.new(
  :schedule_name,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :content_range,
  :recurrence,
  :client_request_token)
  include Aws::Structure
end

#formatString

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

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 780

class CreateBusinessReportScheduleRequest < Struct.new(
  :schedule_name,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :content_range,
  :recurrence,
  :client_request_token)
  include Aws::Structure
end

#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.



780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 780

class CreateBusinessReportScheduleRequest < Struct.new(
  :schedule_name,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :content_range,
  :recurrence,
  :client_request_token)
  include Aws::Structure
end

#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)


780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 780

class CreateBusinessReportScheduleRequest < Struct.new(
  :schedule_name,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :content_range,
  :recurrence,
  :client_request_token)
  include Aws::Structure
end

#s3_key_prefixString

The S3 key where the report is delivered.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 780

class CreateBusinessReportScheduleRequest < Struct.new(
  :schedule_name,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :content_range,
  :recurrence,
  :client_request_token)
  include Aws::Structure
end

#schedule_nameString

The name identifier of the schedule.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 780

class CreateBusinessReportScheduleRequest < Struct.new(
  :schedule_name,
  :s3_bucket_name,
  :s3_key_prefix,
  :format,
  :content_range,
  :recurrence,
  :client_request_token)
  include Aws::Structure
end