Skip to content
AWS for Query.Farm

aws.opensearch.list_scheduled_actions

Example SQL Queries

SELECT * FROM
aws.opensearch.list_scheduled_actions
WHERE
"domain_name" = 'VALUE';

Description

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The name of the domain.

VARCHAR
max_results Input Column

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

BIGINT
next_token Input Column

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

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.

scheduled_actions

A list of actions that are scheduled for the domain.

STRUCT(
    "id" VARCHAR,
    "type" VARCHAR,
    "severity" VARCHAR,
    "scheduled_time" BIGINT,
    "description" VARCHAR,
    "scheduled_by" VARCHAR,
    "status" VARCHAR,
    "mandatory" BOOLEAN,
    "cancellable" BOOLEAN
)[]
Show child fields
scheduled_actions[]
Show child fields
scheduled_actions[].cancellable

Whether or not the scheduled action is cancellable.

scheduled_actions[].description

A description of the action to be taken.

scheduled_actions[].id

The unique identifier of the scheduled action.

scheduled_actions[].mandatory

Whether the action is required or optional.

scheduled_actions[].scheduled_by

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

scheduled_actions[].scheduled_time

The time when the change is scheduled to happen.

scheduled_actions[].severity

The severity of the action.

scheduled_actions[].status

The current status of the scheduled action.

scheduled_actions[].type

The type of action that will be taken on the domain.