Skip to content
AWS for Query.Farm

aws.ivschat.list_rooms

Example SQL Queries

SELECT * FROM
aws.ivschat.list_rooms;

Description

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

Table Definition

Column NameColumn Data Type
logging_configuration_identifier Input Column

Logging-configuration identifier.

VARCHAR
max_results Input Column

Maximum number of rooms to return. Default: 50.

BIGINT
message_review_handler_uri Input Column

Filters the list to match the specified message review handler URI.

VARCHAR
name Input Column

Filters the list to match the specified room name.

VARCHAR
next_token Input Column

If there are more rooms than maxResults, use nextToken in the request to get the next set.

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
rooms

List of the matching rooms (summary information only).

STRUCT(
    "arn" VARCHAR,
    "id" VARCHAR,
    "name" VARCHAR,
    "message_review_handler" STRUCT(
        "uri" VARCHAR,
        "fallback_result" VARCHAR
    ),
    "create_time" TIMESTAMP_S,
    "update_time" TIMESTAMP_S,
    "tags" MAP(VARCHAR, VARCHAR),
    "logging_configuration_identifiers" VARCHAR[]
)[]
Show child fields
rooms[]
Show child fields
rooms[].arn

Room ARN.

rooms[].create_time

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

rooms[].id

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

rooms[].logging_configuration_identifiers[]
rooms[].message_review_handler

Configuration information for optional review of messages.

Show child fields
rooms[].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.

rooms[].message_review_handler.uri

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

rooms[].name

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

rooms[].tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

rooms[].update_time

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