Skip to content
AWS for Query.Farm

aws.ivschat.get_room

Example SQL Queries

SELECT * FROM
aws.ivschat.get_room
WHERE
"identifier" = 'VALUE';

Description

Gets the specified room.

Table Definition

Column NameColumn Data Type
identifier Required Input Column

Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

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

Room ARN, from the request (if identifier was an ARN).

VARCHAR
create_time

Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

TIMESTAMP_S
id

Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

VARCHAR
logging_configuration_identifiers

Array of logging configurations attached to the room.

VARCHAR[]
Show child fields
logging_configuration_identifiers[]
maximum_message_length

Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

BIGINT
maximum_message_rate_per_second

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

BIGINT
message_review_handler

Configuration information for optional review of messages.

STRUCT(
    "uri" VARCHAR,
    "fallback_result" VARCHAR
)
Show child fields
message_review_handler.fallback_result

Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.

message_review_handler.uri

Identifier of the message review handler. Currently this must be an ARN of a lambda function.

name

Room name. The value does not need to be unique.

VARCHAR
tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value).

MAP(VARCHAR, VARCHAR)
update_time

Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

TIMESTAMP_S