Skip to content
AWS for Query.Farm

aws.quicksight.list_refresh_schedules

Example SQL Queries

SELECT * FROM
aws.quicksight.list_refresh_schedules
WHERE
"aws_account_id" = 'VALUE'
AND "data_set_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The Amazon Web Services account ID.

VARCHAR
data_set_id Required Input Column

The ID of the dataset.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
refresh_schedules

The list of refresh schedules for the dataset.

STRUCT(
    "schedule_id" VARCHAR,
    "schedule_frequency" STRUCT(
        "interval" VARCHAR,
        "refresh_on_day" STRUCT(
            "day_of_week" VARCHAR,
            "day_of_month" VARCHAR
        ),
        "timezone" VARCHAR,
        "time_of_the_day" VARCHAR
    ),
    "start_after_date_time" TIMESTAMP_S,
    "refresh_type" VARCHAR,
    "arn" VARCHAR
)[]
Show child fields
refresh_schedules[]
Show child fields
refresh_schedules[].arn

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

refresh_schedules[].refresh_type

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.

refresh_schedules[].schedule_frequency

The frequency for the refresh schedule.

Show child fields
refresh_schedules[].schedule_frequency.interval

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.

refresh_schedules[].schedule_frequency.refresh_on_day

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

Show child fields
refresh_schedules[].schedule_frequency.refresh_on_day.day_of_month

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

refresh_schedules[].schedule_frequency.refresh_on_day.day_of_week

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

refresh_schedules[].schedule_frequency.time_of_the_day

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.

refresh_schedules[].schedule_frequency.timezone

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

refresh_schedules[].schedule_id

An identifier for the refresh schedule.

refresh_schedules[].start_after_date_time

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

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT