Skip to content
AWS for Query.Farm

aws.lightsail.get_contact_methods

Example SQL Queries

SELECT * FROM
aws.lightsail.get_contact_methods;

Description

Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

Table Definition

Column NameColumn Data Type
protocols Input Column

The protocols used to send notifications, such as Email, or SMS (text messaging).

Specify a protocol in your request to return information about a specific contact method protocol.

VARCHAR[]
Show child fields
protocols[]
_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_methods

An array of objects that describe the contact methods.

STRUCT(
    "contact_endpoint" VARCHAR,
    "status" VARCHAR,
    "protocol" VARCHAR,
    "name" VARCHAR,
    "arn" VARCHAR,
    "created_at" TIMESTAMP_S,
    "location" STRUCT(
        "availability_zone" VARCHAR,
        "region_name" VARCHAR
    ),
    "resource_type" VARCHAR,
    "support_code" VARCHAR
)[]
Show child fields
contact_methods[]
Show child fields
contact_methods[].arn

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

contact_methods[].contact_endpoint

The destination of the contact method, such as an email address or a mobile phone number.

contact_methods[].created_at

The timestamp when the contact method was created.

contact_methods[].location

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

Show child fields
contact_methods[].location.availability_zone

The Availability Zone. Follows the format us-east-2a (case-sensitive).

contact_methods[].location.region_name

The Amazon Web Services Region name.

contact_methods[].name

The name of the contact method.

contact_methods[].protocol

The protocol of the contact method, such as email or SMS (text messaging).

contact_methods[].resource_type

The Lightsail resource type of the contact method.

contact_methods[].status

The current status of the contact method.

A contact method has the following possible status:

  • PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.

  • Valid - The contact method has been verified.

  • InValid - An attempt was made to verify the contact method, but the verification has expired.

contact_methods[].support_code

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.