Skip to content
AWS for Query.Farm

aws.privatenetworks.list_network_sites

Example SQL Queries

SELECT * FROM
aws.privatenetworks.list_network_sites
WHERE
"network_arn" = 'VALUE';

Description

Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.

Table Definition

Column NameColumn Data Type
network_arn Required Input Column

The Amazon Resource Name (ARN) of the network to which the network site belongs.

VARCHAR
filters Input Column

The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

  • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

MAP(VARCHAR, 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.

availability_zone

The parent Availability Zone for the network site. 

VARCHAR
availability_zone_id

The parent Availability Zone ID for the network site. 

VARCHAR
created_at

The creation time of the network site.

TIMESTAMP_S
current_plan

The current plan of the network site.

STRUCT(
    "options" STRUCT(
        "name" VARCHAR,
        "value" VARCHAR
    )[],
    "resource_definitions" STRUCT(
        "count" BIGINT,
        "options" STRUCT(
            "name" VARCHAR,
            "value" VARCHAR
        )[],
        "type" VARCHAR
    )[]
)
Show child fields
current_plan.options[]
Show child fields
current_plan.options[].name

The name of the pair.

current_plan.options[].value

The value of the pair.

current_plan.resource_definitions[]
Show child fields
current_plan.resource_definitions[].count

The count in the network resource definition.

current_plan.resource_definitions[].options[]
Show child fields
current_plan.resource_definitions[].options[].name

The name of the pair.

current_plan.resource_definitions[].options[].value

The value of the pair.

current_plan.resource_definitions[].type

The type in the network resource definition.

description

The description of the network site.

VARCHAR
network_site_arn

The Amazon Resource Name (ARN) of the network site.

VARCHAR
network_site_name

The name of the network site.

VARCHAR
pending_plan

The pending plan of the network site.

STRUCT(
    "options" STRUCT(
        "name" VARCHAR,
        "value" VARCHAR
    )[],
    "resource_definitions" STRUCT(
        "count" BIGINT,
        "options" STRUCT(
            "name" VARCHAR,
            "value" VARCHAR
        )[],
        "type" VARCHAR
    )[]
)
Show child fields
pending_plan.options[]
Show child fields
pending_plan.options[].name

The name of the pair.

pending_plan.options[].value

The value of the pair.

pending_plan.resource_definitions[]
Show child fields
pending_plan.resource_definitions[].count

The count in the network resource definition.

pending_plan.resource_definitions[].options[]
Show child fields
pending_plan.resource_definitions[].options[].name

The name of the pair.

pending_plan.resource_definitions[].options[].value

The value of the pair.

pending_plan.resource_definitions[].type

The type in the network resource definition.

status

The status of the network site.

VARCHAR
status_reason

The status reason of the network site.

VARCHAR