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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

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)


684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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_rangeTypes::BusinessReportContentRange

The content range of the reports.



684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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

#formatString

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

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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

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



684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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


684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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_prefixString

The S3 key where the report is delivered.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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_nameString

The name identifier of the schedule.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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

#tagsArray<Types::Tag>

The tags for the business report schedule.

Returns:



684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 684

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