Skip to content
AWS for Query.Farm

aws.events.describe_connection

Example SQL Queries

SELECT * FROM
aws.events.describe_connection
WHERE
"name" = 'VALUE';

Description

Retrieves details about a connection.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the connection retrieved.

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
auth_parameters

The parameters to use for authorization for the connection.

STRUCT(
    "basic_auth_parameters" STRUCT(
        "username" VARCHAR
    ),
    "o_auth_parameters" STRUCT(
        "client_parameters" STRUCT(
            "client_id" VARCHAR
        ),
        "authorization_endpoint" VARCHAR,
        "http_method" VARCHAR,
        "o_auth_http_parameters" STRUCT(
            "header_parameters" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR,
                "is_value_secret" BOOLEAN
            )[],
            "query_string_parameters" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR,
                "is_value_secret" BOOLEAN
            )[],
            "body_parameters" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR,
                "is_value_secret" BOOLEAN
            )[]
        )
    ),
    "api_key_auth_parameters" STRUCT(
        "api_key_name" VARCHAR
    ),
    "invocation_http_parameters" STRUCT(
        "header_parameters" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR,
            "is_value_secret" BOOLEAN
        )[],
        "query_string_parameters" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR,
            "is_value_secret" BOOLEAN
        )[],
        "body_parameters" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR,
            "is_value_secret" BOOLEAN
        )[]
    )
)
Show child fields
auth_parameters.api_key_auth_parameters

The API Key parameters to use for authorization.

Show child fields
auth_parameters.api_key_auth_parameters.api_key_name

The name of the header to use for the APIKeyValue used for authorization.

auth_parameters.basic_auth_parameters

The authorization parameters for Basic authorization.

Show child fields
auth_parameters.basic_auth_parameters.username

The user name to use for Basic authorization.

auth_parameters.invocation_http_parameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

Show child fields
auth_parameters.invocation_http_parameters.body_parameters[]
Show child fields
auth_parameters.invocation_http_parameters.body_parameters[].is_value_secret

Specified whether the value is secret.

auth_parameters.invocation_http_parameters.body_parameters[].key

The key for the parameter.

auth_parameters.invocation_http_parameters.body_parameters[].value

The value associated with the key.

auth_parameters.invocation_http_parameters.header_parameters[]
Show child fields
auth_parameters.invocation_http_parameters.header_parameters[].is_value_secret

Specified whether the value is a secret.

auth_parameters.invocation_http_parameters.header_parameters[].key

The key for the parameter.

auth_parameters.invocation_http_parameters.header_parameters[].value

The value associated with the key.

auth_parameters.invocation_http_parameters.query_string_parameters[]
Show child fields
auth_parameters.invocation_http_parameters.query_string_parameters[].is_value_secret

Specifies whether the value is secret.

auth_parameters.invocation_http_parameters.query_string_parameters[].key

The key for a query string parameter.

auth_parameters.invocation_http_parameters.query_string_parameters[].value

The value associated with the key for the query string parameter.

auth_parameters.o_auth_parameters

The OAuth parameters to use for authorization.

Show child fields
auth_parameters.o_auth_parameters.authorization_endpoint

The URL to the HTTP endpoint that authorized the request.

auth_parameters.o_auth_parameters.client_parameters

A ConnectionOAuthClientResponseParameters object that contains details about the client parameters returned when OAuth is specified as the authorization type.

Show child fields
auth_parameters.o_auth_parameters.client_parameters.client_id

The client ID associated with the response to the connection request.

auth_parameters.o_auth_parameters.http_method

The method used to connect to the HTTP endpoint.

auth_parameters.o_auth_parameters.o_auth_http_parameters

The additional HTTP parameters used for the OAuth authorization request.

Show child fields
auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[]
Show child fields
auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[].is_value_secret

Specified whether the value is secret.

auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[].key

The key for the parameter.

auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[].value

The value associated with the key.

auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[]
Show child fields
auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[].is_value_secret

Specified whether the value is a secret.

auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[].key

The key for the parameter.

auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[].value

The value associated with the key.

auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[]
Show child fields
auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[].is_value_secret

Specifies whether the value is secret.

auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[].key

The key for a query string parameter.

auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[].value

The value associated with the key for the query string parameter.

authorization_type

The type of authorization specified for the connection.

VARCHAR
connection_arn

The ARN of the connection retrieved.

VARCHAR
connection_state

The state of the connection retrieved.

VARCHAR
creation_time

A time stamp for the time that the connection was created.

TIMESTAMP_S
description

The description for the connection retrieved.

VARCHAR
last_authorized_time

A time stamp for the time that the connection was last authorized.

TIMESTAMP_S
last_modified_time

A time stamp for the time that the connection was last modified.

TIMESTAMP_S
secret_arn

The ARN of the secret created from the authorization parameters specified for the connection.

VARCHAR
state_reason

The reason that the connection is in the current connection state.

VARCHAR