Skip to content

aws.oam.get_link

Example SQL Queries

SELECT * FROM
aws.oam.get_link
WHERE
"identifier" = 'VALUE';

Description

Returns complete information about one link.

To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.

Table Definition

Column NameColumn Data Type
identifier Required Input Column

The ARN of the link to retrieve information for.

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
arn

The ARN of the link.

VARCHAR
id

The random ID string that Amazon Web Services generated as part of the link ARN.

VARCHAR
label

The label that you assigned to this link, with the variables resolved to their actual values.

VARCHAR
label_template

The exact label template that was specified when the link was created, with the template variables not resolved.

VARCHAR
link_configuration

This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

STRUCT(
"log_group_configuration" STRUCT(
"filter" VARCHAR
),
"metric_configuration" STRUCT(
"filter" VARCHAR
)
)
Show child fields
link_configuration.log_group_configuration

Use this structure to filter which log groups are to send log events from the source account to the monitoring account.

Show child fields
link_configuration.log_group_configuration.filter

Use this field to specify which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands. Use single quotation marks (') around log group names. The matching of log group names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR.

  • = and !=

  • AND

  • OR

  • LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.

  • IN and NOT IN, using parentheses ( )

Examples:

  • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group.

  • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2.

  • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs.

If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.

link_configuration.metric_configuration

Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.

Show child fields
link_configuration.metric_configuration.filter

Use this field to specify which metrics are to be shared with the monitoring account. Use the term Namespace and one or more of the following operands. Use single quotation marks (') around namespace names. The matching of namespace names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR.

  • = and !=

  • AND

  • OR

  • LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.

  • IN and NOT IN, using parentheses ( )

Examples:

  • Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/, such as custom namespaces.

  • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing, and Amazon S3 namespaces.

  • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.

If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all metric namespaces with the monitoring account.

resource_types

The resource types supported by this link.

VARCHAR[]
Show child fields
resource_types[]
sink_arn

The ARN of the sink that is used for this link.

VARCHAR
tags

The tags assigned to the link.

MAP(VARCHAR, VARCHAR)