Skip to content

aws.redshift.describe_scheduled_actions

Example SQL Queries

SELECT * FROM
aws.redshift.describe_scheduled_actions;

Description

Describes properties of scheduled actions.

Table Definition

Column NameColumn Data Type
active Input Column

If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

BOOLEAN
end_time Input Column

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

TIMESTAMP_S
filters Input Column

List of scheduled action filters.

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The type of element to filter.

filters[].values[]
scheduled_action_name Input Column

The name of the scheduled action.

VARCHAR
start_time Input Column

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

TIMESTAMP_S
target_action_type Input Column

The type of the scheduled actions to retrieve.

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
iam_role

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (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 Cluster Management Guide.

VARCHAR
next_invocations

List of times when the scheduled action will run.

TIMESTAMP_S[]
Show child fields
next_invocations[]
schedule

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

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

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

VARCHAR
scheduled_action_description

The description of the scheduled action.

VARCHAR
state

The state of the scheduled action. For example, DISABLED.

VARCHAR
target_action

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

STRUCT(
"resize_cluster" STRUCT(
"cluster_identifier" VARCHAR,
"cluster_type" VARCHAR,
"node_type" VARCHAR,
"number_of_nodes" BIGINT,
"classic" BOOLEAN,
"reserved_node_id" VARCHAR,
"target_reserved_node_offering_id" VARCHAR
),
"pause_cluster" STRUCT(
"cluster_identifier" VARCHAR
),
"resume_cluster" STRUCT(
"cluster_identifier" VARCHAR
)
)
Show child fields
target_action.pause_cluster

An action that runs a PauseCluster API operation.

Show child fields
target_action.pause_cluster.cluster_identifier

The identifier of the cluster to be paused.

target_action.resize_cluster

An action that runs a ResizeCluster API operation.

Show child fields
target_action.resize_cluster.classic

A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

target_action.resize_cluster.cluster_identifier

The unique identifier for the cluster to resize.

target_action.resize_cluster.cluster_type

The new cluster type for the specified cluster.

target_action.resize_cluster.node_type

The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

target_action.resize_cluster.number_of_nodes

The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

target_action.resize_cluster.reserved_node_id

The identifier of the reserved node.

target_action.resize_cluster.target_reserved_node_offering_id

The identifier of the target reserved node offering.

target_action.resume_cluster

An action that runs a ResumeCluster API operation.

Show child fields
target_action.resume_cluster.cluster_identifier

The identifier of the cluster to be resumed.