Class: Aws::QuickSight::Types::KnowledgeBaseRefreshFrequency

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

Overview

Specifies how often a knowledge base refresh schedule runs and, for weekly or monthly schedules, which day the refresh runs.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#interval ⇒ String

The interval at which the schedule refreshes the knowledge base. Valid values include:

  • DAILY – The schedule refreshes the knowledge base once each day.

  • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

  • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

  • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

Returns:

  • (String)


33056
33057
33058
33059
33060
33061
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 33056

class KnowledgeBaseRefreshFrequency < Struct.new(
  :interval,
  :refresh_on_day)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_on_day ⇒ Types::KnowledgeBaseScheduleRefreshOnEntity

The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.



33056
33057
33058
33059
33060
33061
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 33056

class KnowledgeBaseRefreshFrequency < Struct.new(
  :interval,
  :refresh_on_day)
  SENSITIVE = []
  include Aws::Structure
end