Skip to content
AWS for Query.Farm

aws.ssm_contacts.get_rotation

Example SQL Queries

SELECT * FROM
aws.ssm_contacts.get_rotation
WHERE
"rotation_id" = 'VALUE';

Description

Retrieves information about an on-call rotation.

Table Definition

Column NameColumn Data Type
rotation_id Required Input Column

The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.

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
contact_ids

The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.

VARCHAR[]
Show child fields
contact_ids[]
name

The name of the on-call rotation.

VARCHAR
recurrence

Specifies how long a rotation lasts before restarting at the beginning of the shift order.

STRUCT(
    "monthly_settings" STRUCT(
        "day_of_month" BIGINT,
        "hand_off_time" STRUCT(
            "hour_of_day" BIGINT,
            "minute_of_hour" BIGINT
        )
    )[],
    "weekly_settings" STRUCT(
        "day_of_week" VARCHAR,
        "hand_off_time" STRUCT(
            "hour_of_day" BIGINT,
            "minute_of_hour" BIGINT
        )
    )[],
    "daily_settings" STRUCT(
        "hour_of_day" BIGINT,
        "minute_of_hour" BIGINT
    )[],
    "number_of_on_calls" BIGINT,
    "shift_coverages" MAP(VARCHAR, STRUCT(
            "start" STRUCT(
                "hour_of_day" BIGINT,
                "minute_of_hour" BIGINT
            ),
            "end" STRUCT(
                "hour_of_day" BIGINT,
                "minute_of_hour" BIGINT
            )
        )[]),
    "recurrence_multiplier" BIGINT
)
Show child fields
recurrence.daily_settings[]
Show child fields
recurrence.daily_settings[].hour_of_day

The hour when an on-call rotation shift begins or ends.

recurrence.daily_settings[].minute_of_hour

The minute when an on-call rotation shift begins or ends.

recurrence.monthly_settings[]
Show child fields
recurrence.monthly_settings[].day_of_month

The day of the month when monthly recurring on-call rotations begin.

recurrence.monthly_settings[].hand_off_time

The time of day when a monthly recurring on-call shift rotation begins.

Show child fields
recurrence.monthly_settings[].hand_off_time.hour_of_day

The hour when an on-call rotation shift begins or ends.

recurrence.monthly_settings[].hand_off_time.minute_of_hour

The minute when an on-call rotation shift begins or ends.

recurrence.number_of_on_calls

The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.

recurrence.recurrence_multiplier

The number of days, weeks, or months a single rotation lasts.

recurrence.shift_coverages

Information about the days of the week included in on-call rotation coverage.

recurrence.weekly_settings[]
Show child fields
recurrence.weekly_settings[].day_of_week

The day of the week when weekly recurring on-call shift rotations begins.

recurrence.weekly_settings[].hand_off_time

The time of day when a weekly recurring on-call shift rotation begins.

Show child fields
recurrence.weekly_settings[].hand_off_time.hour_of_day

The hour when an on-call rotation shift begins or ends.

recurrence.weekly_settings[].hand_off_time.minute_of_hour

The minute when an on-call rotation shift begins or ends.

rotation_arn

The Amazon Resource Name (ARN) of the on-call rotation.

VARCHAR
start_time

The specified start time for the on-call rotation.

TIMESTAMP_S
time_zone_id

The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.

VARCHAR