Skip to content

RefreshSchedule

Used by
Source code in docs_src/capo_quicksight/types/refresh_schedule.py 
17
18
19
20
21
22
23
24
25
26
27
class RefreshSchedule(TypedDict, closed=True):
    schedule_id: "capo_quicksight.types.string.String"
    """<p>An identifier for the refresh schedule.</p>"""
    schedule_frequency: "capo_quicksight.types.refresh_frequency.RefreshFrequency"
    """<p>The frequency for the refresh schedule.</p>"""
    start_after_date_time: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p>Time after which the refresh schedule can be started, expressed in <code>YYYY-MM-DDTHH:MM:SS</code> format.</p>"""
    refresh_type: "capo_quicksight.types.ingestion_type.IngestionType"
    """<p>The type of refresh that a datset undergoes. Valid values are as follows:</p> <ul> <li> <p> <code>FULL_REFRESH</code>: A complete refresh of a dataset.</p> </li> <li> <p> <code>INCREMENTAL_REFRESH</code>: A partial refresh of some rows of a dataset, based on the time window specified.</p> </li> </ul> <p>For more information on full and incremental refreshes, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html">Refreshing SPICE data</a> in the <i>Amazon Quick Suite User Guide</i>.</p>"""
    arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) for the refresh schedule.</p>"""

arn instance-attribute 

arn: NotRequired[Arn]

The Amazon Resource Name (ARN) for the refresh schedule.

refresh_type instance-attribute 

refresh_type: IngestionType

The type of refresh that a datset undergoes. Valid values are as follows:

  • FULL_REFRESH: A complete refresh of a dataset.

  • INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon Quick Suite User Guide.

schedule_frequency instance-attribute 

schedule_frequency: RefreshFrequency

The frequency for the refresh schedule.

schedule_id instance-attribute 

schedule_id: String

An identifier for the refresh schedule.

start_after_date_time instance-attribute 

start_after_date_time: NotRequired[Timestamp]

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.