Skip to content
AWS for Query.Farm

aws.ssm_incidents.list_related_items

Example SQL Queries

SELECT * FROM
aws.ssm_incidents.list_related_items
WHERE
"incident_record_arn" = 'VALUE';

Description

List all related items for an incident record.

Table Definition

Column NameColumn Data Type
incident_record_arn Required Input Column

The Amazon Resource Name (ARN) of the incident record containing the listed related items.

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
generated_id

A unique ID for a RelatedItem.

Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action.

VARCHAR
identifier

Details about the related item.

STRUCT(
    "type" VARCHAR,
    "value" STRUCT(
        "arn" VARCHAR,
        "metric_definition" VARCHAR,
        "pager_duty_incident_detail" STRUCT(
            "auto_resolve" BOOLEAN,
            "id" VARCHAR,
            "secret_id" VARCHAR
        ),
        "url" VARCHAR
    )
)
Show child fields
identifier.type

The type of related item.

identifier.value

Details about the related item.

Show child fields
identifier.value.arn

The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

identifier.value.metric_definition

The metric definition, if the related item is a metric in Amazon CloudWatch.

identifier.value.pager_duty_incident_detail

Details about an incident that is associated with a PagerDuty incident.

Show child fields
identifier.value.pager_duty_incident_detail.auto_resolve

Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.

identifier.value.pager_duty_incident_detail.id

The ID of the incident associated with the PagerDuty service for the response plan.

identifier.value.pager_duty_incident_detail.secret_id

The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

identifier.value.url

The URL, if the related item is a non-Amazon Web Services resource.

title

The title of the related item.

VARCHAR