QuickSight / Client / list_refresh_schedules

list_refresh_schedules#

QuickSight.Client.list_refresh_schedules(**kwargs)#

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

See also: AWS API Documentation

Request Syntax

response = client.list_refresh_schedules(
    AwsAccountId='string',
    DataSetId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID.

  • DataSetId (string) –

    [REQUIRED]

    The ID of the dataset.

Return type:

dict

Returns:

Response Syntax

{
    'RefreshSchedules': [
        {
            'ScheduleId': 'string',
            'ScheduleFrequency': {
                'Interval': 'MINUTE15'|'MINUTE30'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                'RefreshOnDay': {
                    'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                    'DayOfMonth': 'string'
                },
                'Timezone': 'string',
                'TimeOfTheDay': 'string'
            },
            'StartAfterDateTime': datetime(2015, 1, 1),
            'RefreshType': 'INCREMENTAL_REFRESH'|'FULL_REFRESH',
            'Arn': 'string'
        },
    ],
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • RefreshSchedules (list) –

      The list of refresh schedules for the dataset.

      • (dict) –

        A list of RefreshSchedule objects.

        • ScheduleId (string) –

          An identifier for the refresh schedule.

        • ScheduleFrequency (dict) –

          The frequency for the refresh schedule.

          • Interval (string) –

            The interval between scheduled refreshes. Valid values are as follows:

            • MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

            • MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

            • HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

            • DAILY: The dataset refreshes every day.

            • WEEKLY: The dataset refreshes every week.

            • MONTHLY: The dataset refreshes every month.

          • RefreshOnDay (dict) –

            The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

            • DayOfWeek (string) –

              The day of the week that you want to schedule a refresh on.

            • DayOfMonth (string) –

              The day of the month that you want to schedule refresh on.

          • Timezone (string) –

            The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

          • TimeOfTheDay (string) –

            The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

        • StartAfterDateTime (datetime) –

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

        • RefreshType (string) –

          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 QuickSight User Guide.

        • Arn (string) –

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

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.InternalFailureException