Skip to content
AWS for Query.Farm

aws.redshift_serverless.get_scheduled_action

Example SQL Queries

SELECT * FROM
aws.redshift_serverless.get_scheduled_action
WHERE
"scheduled_action_name" = 'VALUE';

Description

Returns information about a scheduled action.

Table Definition

Column NameColumn Data Type
scheduled_action_name Required Input Column

The name of the scheduled action.

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
scheduled_action

The returned scheduled action object.

STRUCT(
    "end_time" TIMESTAMP_S,
    "namespace_name" VARCHAR,
    "next_invocations" TIMESTAMP_S[],
    "role_arn" VARCHAR,
    "schedule" STRUCT(
        "at" TIMESTAMP_S,
        "cron" VARCHAR
    ),
    "scheduled_action_description" VARCHAR,
    "scheduled_action_name" VARCHAR,
    "scheduled_action_uuid" VARCHAR,
    "start_time" TIMESTAMP_S,
    "state" VARCHAR,
    "target_action" STRUCT(
        "create_snapshot" STRUCT(
            "namespace_name" VARCHAR,
            "retention_period" BIGINT,
            "snapshot_name_prefix" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )
    )
)
Show child fields
scheduled_action.end_time

The end time of

scheduled_action.namespace_name

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

scheduled_action.next_invocations[]
scheduled_action.role_arn

The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide

scheduled_action.schedule

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

  • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

  • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

Show child fields
scheduled_action.schedule.at

The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

scheduled_action.schedule.cron

The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

Format of cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

scheduled_action.scheduled_action_description

The description of the scheduled action.

scheduled_action.scheduled_action_name

The name of the scheduled action.

scheduled_action.scheduled_action_uuid

The uuid of the scheduled action.

scheduled_action.start_time

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

scheduled_action.state

The state of the scheduled action.

scheduled_action.target_action

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

Show child fields
scheduled_action.target_action.create_snapshot

The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

Show child fields
scheduled_action.target_action.create_snapshot.namespace_name

The name of the namespace for which you want to configure a scheduled action to create a snapshot.

scheduled_action.target_action.create_snapshot.retention_period

The retention period of the snapshot created by the scheduled action.

scheduled_action.target_action.create_snapshot.snapshot_name_prefix

A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

scheduled_action.target_action.create_snapshot.tags[]
Show child fields
scheduled_action.target_action.create_snapshot.tags[].key

The key to use in the tag.

scheduled_action.target_action.create_snapshot.tags[].value

The value of the tag.