Skip to content
AWS for Query.Farm

aws.nimble.get_launch_profile

Example SQL Queries

SELECT * FROM
aws.nimble.get_launch_profile
WHERE
"launch_profile_id" = 'VALUE'
AND "studio_id" = 'VALUE';

Description

Get a launch profile.

Table Definition

Column NameColumn Data Type
launch_profile_id Required Input Column

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

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
launch_profile

The launch profile.

STRUCT(
    "arn" VARCHAR,
    "created_at" TIMESTAMP_S,
    "created_by" VARCHAR,
    "description" VARCHAR,
    "ec2_subnet_ids" VARCHAR[],
    "launch_profile_id" VARCHAR,
    "launch_profile_protocol_versions" VARCHAR[],
    "name" VARCHAR,
    "state" VARCHAR,
    "status_code" VARCHAR,
    "status_message" VARCHAR,
    "stream_configuration" STRUCT(
        "automatic_termination_mode" VARCHAR,
        "clipboard_mode" VARCHAR,
        "ec2_instance_types" VARCHAR[],
        "max_session_length_in_minutes" BIGINT,
        "max_stopped_session_length_in_minutes" BIGINT,
        "session_backup" STRUCT(
            "max_backups_to_retain" BIGINT,
            "mode" VARCHAR
        ),
        "session_persistence_mode" VARCHAR,
        "session_storage" STRUCT(
            "mode" VARCHAR[],
            "root" STRUCT(
                "linux" VARCHAR,
                "windows" VARCHAR
            )
        ),
        "streaming_image_ids" VARCHAR[],
        "volume_configuration" STRUCT(
            "iops" BIGINT,
            "size" BIGINT,
            "throughput" BIGINT
        )
    ),
    "studio_component_ids" VARCHAR[],
    "tags" MAP(VARCHAR, VARCHAR),
    "updated_at" TIMESTAMP_S,
    "updated_by" VARCHAR,
    "validation_results" STRUCT(
        "state" VARCHAR,
        "status_code" VARCHAR,
        "status_message" VARCHAR,
        "type" VARCHAR
    )[]
)
Show child fields
launch_profile.arn

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

launch_profile.created_at

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

launch_profile.created_by

The user ID of the user that created the launch profile.

launch_profile.description

A human-readable description of the launch profile.

launch_profile.ec2_subnet_ids[]
launch_profile.launch_profile_id

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

launch_profile.launch_profile_protocol_versions[]
launch_profile.name

A friendly name for the launch profile.

launch_profile.state

The current state.

launch_profile.status_code

The status code.

launch_profile.status_message

The status message for the launch profile.

launch_profile.stream_configuration

A configuration for a streaming session.

Show child fields
launch_profile.stream_configuration.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.

launch_profile.stream_configuration.clipboard_mode

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

launch_profile.stream_configuration.ec2_instance_types[]
launch_profile.stream_configuration.max_session_length_in_minutes

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

launch_profile.stream_configuration.max_stopped_session_length_in_minutes

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

launch_profile.stream_configuration.session_backup

Information about the streaming session backup.

Show child fields
launch_profile.stream_configuration.session_backup.max_backups_to_retain

The maximum number of backups that each streaming session created from this launch profile can have.

launch_profile.stream_configuration.session_backup.mode

Specifies how artists sessions are backed up.

Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.

launch_profile.stream_configuration.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.

launch_profile.stream_configuration.session_storage

The upload storage for a streaming session.

Show child fields
launch_profile.stream_configuration.session_storage.mode[]
launch_profile.stream_configuration.session_storage.root

The configuration for the upload storage root of the streaming session.

Show child fields
launch_profile.stream_configuration.session_storage.root.linux

The folder path in Linux workstations where files are uploaded.

launch_profile.stream_configuration.session_storage.root.windows

The folder path in Windows workstations where files are uploaded.

launch_profile.stream_configuration.streaming_image_ids[]
launch_profile.stream_configuration.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
launch_profile.stream_configuration.volume_configuration.iops

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

launch_profile.stream_configuration.volume_configuration.size

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

launch_profile.stream_configuration.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.

launch_profile.studio_component_ids[]
launch_profile.tags

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

launch_profile.updated_at

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

launch_profile.updated_by

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

launch_profile.validation_results[]
Show child fields
launch_profile.validation_results[].state

The current state.

launch_profile.validation_results[].status_code

The status code. This will contain the failure reason if the state is VALIDATION_FAILED.

launch_profile.validation_results[].status_message

The status message for the validation result.

launch_profile.validation_results[].type

The type of the validation result.