Skip to content
AWS for Query.Farm

aws.ssm.describe_sessions

Example SQL Queries

SELECT * FROM
aws.ssm.describe_sessions
WHERE
"state" = 'VALUE';

Description

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Table Definition

Column NameColumn Data Type
state Required Input Column

The session status to retrieve a list of sessions for. For example, "Active".

VARCHAR
filters Input Column

One or more filters to limit the type of sessions returned by the request.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].key

The name of the filter.

filters[].value

The filter value. Valid values for each filter key are as follows:

  • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.

  • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.

  • Target: Specify a managed node to which session connections have been made.

  • Owner: Specify an Amazon Web Services user to see a list of sessions started by that user.

  • Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:

    • Connected

    • Connecting

    • Disconnected

    • Terminated

    • Terminating

    • Failed

  • SessionId: Specify a session ID to return details about the session.

_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
details

Reserved for future use.

VARCHAR
document_name

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

VARCHAR
end_date

The date and time, in ISO-8601 Extended format, when the session was terminated.

TIMESTAMP_S
max_session_duration

The maximum duration of a session before it terminates.

VARCHAR
output_url

Reserved for future use.

STRUCT(
    "s3_output_url" VARCHAR,
    "cloud_watch_output_url" VARCHAR
)
Show child fields
output_url.cloud_watch_output_url

Reserved for future use.

output_url.s3_output_url

Reserved for future use.

owner

The ID of the Amazon Web Services user that started the session.

VARCHAR
reason

The reason for connecting to the instance.

VARCHAR
session_id

The ID of the session.

VARCHAR
start_date

The date and time, in ISO-8601 Extended format, when the session began.

TIMESTAMP_S
status

The status of the session. For example, "Connected" or "Terminated".

VARCHAR
target

The managed node that the Session Manager session connected to.

VARCHAR