Skip to content
AWS for Query.Farm

aws.mediaconnect.describe_gateway

Example SQL Queries

SELECT * FROM
aws.mediaconnect.describe_gateway
WHERE
"gateway_arn" = 'VALUE';

Description

Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.

Table Definition

Column NameColumn Data Type
gateway_arn Required Input Column

The Amazon Resource Name (ARN) of the gateway that you want to describe.

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
gateway

The settings for a gateway, including its networks.

STRUCT(
    "egress_cidr_blocks" VARCHAR[],
    "gateway_arn" VARCHAR,
    "gateway_messages" STRUCT(
        "code" VARCHAR,
        "message" VARCHAR,
        "resource_name" VARCHAR
    )[],
    "gateway_state" VARCHAR,
    "name" VARCHAR,
    "networks" STRUCT(
        "cidr_block" VARCHAR,
        "name" VARCHAR
    )[]
)
Show child fields
gateway.egress_cidr_blocks[]
gateway.gateway_arn

The Amazon Resource Name (ARN) of the gateway.

gateway.gateway_messages[]
Show child fields
gateway.gateway_messages[].code

The error code.

gateway.gateway_messages[].message

The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

gateway.gateway_messages[].resource_name

The name of the resource.

gateway.gateway_state

The current status of the gateway.

gateway.name

The name of the gateway. This name can not be modified after the gateway is created.

gateway.networks[]
Show child fields
gateway.networks[].cidr_block

A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

gateway.networks[].name

The name of the network. This name is used to reference the network and must be unique among networks in this gateway.