Skip to content
AWS for Query.Farm

aws.mediaconnect.describe_gateway_instance

Example SQL Queries

SELECT * FROM
aws.mediaconnect.describe_gateway_instance
WHERE
"gateway_instance_arn" = 'VALUE';

Description

Displays the details of an instance.

Table Definition

Column NameColumn Data Type
gateway_instance_arn Required Input Column

The Amazon Resource Name (ARN) of the gateway instance 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_instance

The settings for an instance in a gateway.

STRUCT(
    "bridge_placement" VARCHAR,
    "connection_status" VARCHAR,
    "gateway_arn" VARCHAR,
    "gateway_instance_arn" VARCHAR,
    "instance_id" VARCHAR,
    "instance_messages" STRUCT(
        "code" VARCHAR,
        "message" VARCHAR,
        "resource_name" VARCHAR
    )[],
    "instance_state" VARCHAR,
    "running_bridge_count" BIGINT
)
Show child fields
gateway_instance.bridge_placement

The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.

gateway_instance.connection_status

The connection state of the instance.

gateway_instance.gateway_arn

The Amazon Resource Name (ARN) of the instance.

gateway_instance.gateway_instance_arn

The Amazon Resource Name (ARN) of the gateway.

gateway_instance.instance_id

The managed instance ID generated by the SSM install. This will begin with "mi-".

gateway_instance.instance_messages[]
Show child fields
gateway_instance.instance_messages[].code

The error code.

gateway_instance.instance_messages[].message

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

gateway_instance.instance_messages[].resource_name

The name of the resource.

gateway_instance.instance_state

The status of the instance.

gateway_instance.running_bridge_count

The running bridge count.