Skip to content
AWS for Query.Farm

aws.ssm_contacts.describe_engagement

Example SQL Queries

SELECT * FROM
aws.ssm_contacts.describe_engagement
WHERE
"engagement_id" = 'VALUE';

Description

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Table Definition

Column NameColumn Data Type
engagement_id Required Input Column

The Amazon Resource Name (ARN) of the engagement you want the details of.

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_arn

The ARN of the escalation plan or contacts involved in the engagement.

VARCHAR
content

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

VARCHAR
engagement_arn

The ARN of the engagement.

VARCHAR
incident_id

The ARN of the incident in which the engagement occurred.

VARCHAR
public_content

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

VARCHAR
public_subject

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

VARCHAR
sender

The user that started the engagement.

VARCHAR
start_time

The time that the engagement started.

TIMESTAMP_S
stop_time

The time that the engagement ended.

TIMESTAMP_S
subject

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

VARCHAR