Skip to content
AWS for Query.Farm

aws.quicksight.list_topic_refresh_schedules

Example SQL Queries

SELECT * FROM
aws.quicksight.list_topic_refresh_schedules
WHERE
"aws_account_id" = 'VALUE'
AND "topic_id" = 'VALUE';

Description

Lists all of the refresh schedules for a topic.

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.

VARCHAR
topic_id Required Input Column

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

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 topic refresh schedules.

STRUCT(
    "dataset_id" VARCHAR,
    "dataset_arn" VARCHAR,
    "dataset_name" VARCHAR,
    "refresh_schedule" STRUCT(
        "is_enabled" BOOLEAN,
        "based_on_spice_schedule" BOOLEAN,
        "starting_at" TIMESTAMP_S,
        "timezone" VARCHAR,
        "repeat_at" VARCHAR,
        "topic_schedule_type" VARCHAR
    )
)[]
Show child fields
refresh_schedules[]
Show child fields
refresh_schedules[].dataset_arn

The Amazon Resource Name (ARN) of the dataset.

refresh_schedules[].dataset_id

The ID of the dataset.

refresh_schedules[].dataset_name

The name of the dataset.

refresh_schedules[].refresh_schedule

The definition of a refresh schedule.

Show child fields
refresh_schedules[].refresh_schedule.based_on_spice_schedule

A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

refresh_schedules[].refresh_schedule.is_enabled

A Boolean value that controls whether to schedule is enabled.

refresh_schedules[].refresh_schedule.repeat_at

The time of day when the refresh should run, for example, Monday-Sunday.

refresh_schedules[].refresh_schedule.starting_at

The starting date and time for the refresh schedule.

refresh_schedules[].refresh_schedule.timezone

The timezone that you want the refresh schedule to use.

refresh_schedules[].refresh_schedule.topic_schedule_type

The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT
topic_arn

The Amazon Resource Name (ARN) of the topic.

VARCHAR