Skip to content
AWS for Query.Farm

aws.ssm.get_maintenance_window

Example SQL Queries

SELECT * FROM
aws.ssm.get_maintenance_window
WHERE
"window_id" = 'VALUE';

Description

Retrieves a maintenance window.

Table Definition

Column NameColumn Data Type
window_id Required Input Column

The ID of the created maintenance window.

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
allow_unassociated_targets

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

BOOLEAN
created_date

The date the maintenance window was created.

TIMESTAMP_S
cutoff

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

BIGINT
description

The description of the maintenance window.

VARCHAR
duration

The duration of the maintenance window in hours.

BIGINT
enabled

Indicates whether the maintenance window is enabled.

BOOLEAN
end_date

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.

VARCHAR
modified_date

The date the maintenance window was last modified.

TIMESTAMP_S
name

The name of the maintenance window.

VARCHAR
next_execution_time

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

VARCHAR
schedule

The schedule of the maintenance window in the form of a cron or rate expression.

VARCHAR
schedule_offset

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

BIGINT
schedule_timezone

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

VARCHAR
start_date

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.

VARCHAR