Skip to content
AWS for Query.Farm

aws.nimble.get_streaming_session

Example SQL Queries

SELECT * FROM
aws.nimble.get_streaming_session
WHERE
"session_id" = 'VALUE'
AND "studio_id" = 'VALUE';

Description

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

Table Definition

Column NameColumn Data Type
session_id Required Input Column

The streaming session ID.

VARCHAR
studio_id Required Input Column

The studio ID. 

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
session

The session.

STRUCT(
    "arn" VARCHAR,
    "automatic_termination_mode" VARCHAR,
    "backup_mode" VARCHAR,
    "created_at" TIMESTAMP_S,
    "created_by" VARCHAR,
    "ec2_instance_type" VARCHAR,
    "launch_profile_id" VARCHAR,
    "max_backups_to_retain" BIGINT,
    "owned_by" VARCHAR,
    "session_id" VARCHAR,
    "session_persistence_mode" VARCHAR,
    "started_at" TIMESTAMP_S,
    "started_by" VARCHAR,
    "started_from_backup_id" VARCHAR,
    "state" VARCHAR,
    "status_code" VARCHAR,
    "status_message" VARCHAR,
    "stop_at" TIMESTAMP_S,
    "stopped_at" TIMESTAMP_S,
    "stopped_by" VARCHAR,
    "streaming_image_id" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "terminate_at" TIMESTAMP_S,
    "updated_at" TIMESTAMP_S,
    "updated_by" VARCHAR,
    "volume_configuration" STRUCT(
        "iops" BIGINT,
        "size" BIGINT,
        "throughput" BIGINT
    ),
    "volume_retention_mode" VARCHAR
)
Show child fields
session.arn

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

session.automatic_termination_mode

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

  • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

  • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

session.backup_mode

Shows the current backup setting of the session.

session.created_at

The ISO timestamp in seconds for when the resource was created.

session.created_by

The user ID of the user that created the streaming session.

session.ec2_instance_type

The EC2 Instance type used for the streaming session.

session.launch_profile_id

The ID of the launch profile used to control access from the streaming session.

session.max_backups_to_retain

The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

session.owned_by

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

session.session_id

The session ID.

session.session_persistence_mode

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

session.started_at

The time the session entered START_IN_PROGRESS state.

session.started_by

The user ID of the user that started the streaming session.

session.started_from_backup_id

The backup ID used to restore a streaming session.

session.state

The current state.

session.status_code

The status code.

session.status_message

The status message for the streaming session.

session.stop_at

The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

session.stopped_at

The time the session entered STOP_IN_PROGRESS state.

session.stopped_by

The user ID of the user that stopped the streaming session.

session.streaming_image_id

The ID of the streaming image.

session.tags

A collection of labels, in the form of key-value pairs, that apply to this resource.

session.terminate_at

The time the streaming session will automatically terminate if not terminated by the user.

session.updated_at

The ISO timestamp in seconds for when the resource was updated.

session.updated_by

The user ID of the user that most recently updated the resource.

session.volume_configuration

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

Show child fields
session.volume_configuration.iops

The number of I/O operations per second for the root volume that is attached to streaming session.

session.volume_configuration.size

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

session.volume_configuration.throughput

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

session.volume_retention_mode

Determine if an EBS volume created from this streaming session will be backed up.