Skip to content
AWS for Query.Farm

aws.vpc_lattice.get_listener

Example SQL Queries

SELECT * FROM
aws.vpc_lattice.get_listener
WHERE
"listener_identifier" = 'VALUE'
AND "service_identifier" = 'VALUE';

Description

Retrieves information about the specified listener for the specified service.

Table Definition

Column NameColumn Data Type
listener_identifier Required Input Column

The ID or Amazon Resource Name (ARN) of the listener.

VARCHAR
service_identifier Required Input Column

The ID or Amazon Resource Name (ARN) of the service.

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 Amazon Resource Name (ARN) of the listener.

VARCHAR
created_at

The date and time that the listener was created, specified in ISO-8601 format.

TIMESTAMP_S
default_action

The actions for the default listener rule.

STRUCT(
    "fixed_response" STRUCT(
        "status_code" BIGINT
    ),
    "forward" STRUCT(
        "target_groups" STRUCT(
            "target_group_identifier" VARCHAR,
            "weight" BIGINT
        )[]
    )
)
Show child fields
default_action.fixed_response

The fixed response action. The rule returns a custom HTTP response.

Show child fields
default_action.fixed_response.status_code

The HTTP response code.

default_action.forward

The forward action. Traffic that matches the rule is forwarded to the specified target groups.

Show child fields
default_action.forward.target_groups[]
Show child fields
default_action.forward.target_groups[].target_group_identifier

The ID or Amazon Resource Name (ARN) of the target group.

default_action.forward.target_groups[].weight

Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

id

The ID of the listener.

VARCHAR
last_updated_at

The date and time that the listener was last updated, specified in ISO-8601 format.

TIMESTAMP_S
name

The name of the listener.

VARCHAR
port

The listener port.

BIGINT
protocol

The listener protocol.

VARCHAR
service_arn

The Amazon Resource Name (ARN) of the service.

VARCHAR
service_id

The ID of the service.

VARCHAR