Skip to content
AWS for Query.Farm

aws.ssm_incidents.get_incident_record

Example SQL Queries

SELECT * FROM
aws.ssm_incidents.get_incident_record
WHERE
"arn" = 'VALUE';

Description

Returns the details for the specified incident record.

Table Definition

Column NameColumn Data Type
arn Required Input Column

The Amazon Resource Name (ARN) of the incident record.

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
incident_record

Details the structure of the incident record.

STRUCT(
    "arn" VARCHAR,
    "automation_executions" STRUCT(
        "ssm_execution_arn" VARCHAR
    )[],
    "chat_channel" STRUCT(
        "chatbot_sns" VARCHAR[],
        "empty" BOOLEAN
    ),
    "creation_time" TIMESTAMP_S,
    "dedupe_string" VARCHAR,
    "impact" BIGINT,
    "incident_record_source" STRUCT(
        "created_by" VARCHAR,
        "invoked_by" VARCHAR,
        "resource_arn" VARCHAR,
        "source" VARCHAR
    ),
    "last_modified_by" VARCHAR,
    "last_modified_time" TIMESTAMP_S,
    "notification_targets" STRUCT(
        "sns_topic_arn" VARCHAR
    )[],
    "resolved_time" TIMESTAMP_S,
    "status" VARCHAR,
    "summary" VARCHAR,
    "title" VARCHAR
)
Show child fields
incident_record.arn

The Amazon Resource Name (ARN) of the incident record.

incident_record.automation_executions[]
Show child fields
incident_record.automation_executions[].ssm_execution_arn

The Amazon Resource Name (ARN) of the automation process.

incident_record.chat_channel

The chat channel used for collaboration during an incident.

Show child fields
incident_record.chat_channel.chatbot_sns[]
incident_record.chat_channel.empty

Used to remove the chat channel from an incident record or response plan.

incident_record.creation_time

The timestamp for when Incident Manager created the incident record.

incident_record.dedupe_string

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

incident_record.impact

The impact of the incident on customers and applications.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

incident_record.incident_record_source

Details about the action that started the incident.

Show child fields
incident_record.incident_record_source.created_by

The principal that started the incident.

incident_record.incident_record_source.invoked_by

The service principal that assumed the role specified in createdBy. If no service principal assumed the role this will be left blank.

incident_record.incident_record_source.resource_arn

The resource that caused the incident to be created.

incident_record.incident_record_source.source

The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event.

incident_record.last_modified_by

Who modified the incident most recently.

incident_record.last_modified_time

The timestamp for when the incident was most recently modified.

incident_record.notification_targets[]
Show child fields
incident_record.notification_targets[].sns_topic_arn

The Amazon Resource Name (ARN) of the SNS topic.

incident_record.resolved_time

The timestamp for when the incident was resolved. This appears as a timeline event.

incident_record.status

The current status of the incident.

incident_record.summary

The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.

incident_record.title

The title of the incident.