Skip to content
AWS for Query.Farm

aws.ssm_contacts.get_contact

Example SQL Queries

SELECT * FROM
aws.ssm_contacts.get_contact
WHERE
"contact_id" = 'VALUE';

Description

Retrieves information about the specified contact or escalation plan.

Table Definition

Column NameColumn Data Type
contact_id Required Input Column

The Amazon Resource Name (ARN) of the contact or escalation plan.

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
alias

The alias of the contact or escalation plan. The alias is unique and identifiable.

VARCHAR
contact_arn

The ARN of the contact or escalation plan.

VARCHAR
display_name

The full name of the contact or escalation plan.

VARCHAR
plan

Details about the specific timing or stages and targets of the escalation plan or engagement plan.

STRUCT(
    "stages" STRUCT(
        "duration_in_minutes" BIGINT,
        "targets" STRUCT(
            "channel_target_info" STRUCT(
                "contact_channel_id" VARCHAR,
                "retry_interval_in_minutes" BIGINT
            ),
            "contact_target_info" STRUCT(
                "contact_id" VARCHAR,
                "is_essential" BOOLEAN
            )
        )[]
    )[],
    "rotation_ids" VARCHAR[]
)
Show child fields
plan.rotation_ids[]
plan.stages[]
Show child fields
plan.stages[].duration_in_minutes

The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.

plan.stages[].targets[]
Show child fields
plan.stages[].targets[].channel_target_info

Information about the contact channel Incident Manager is engaging.

Show child fields
plan.stages[].targets[].channel_target_info.contact_channel_id

The Amazon Resource Name (ARN) of the contact channel.

plan.stages[].targets[].channel_target_info.retry_interval_in_minutes

The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

plan.stages[].targets[].contact_target_info

Information about the contact that Incident Manager is engaging.

Show child fields
plan.stages[].targets[].contact_target_info.contact_id

The Amazon Resource Name (ARN) of the contact.

plan.stages[].targets[].contact_target_info.is_essential

A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

type

The type of contact, either PERSONAL or ESCALATION.

VARCHAR