Skip to content
AWS for Query.Farm

aws.appstream.describe_images

Example SQL Queries

SELECT * FROM
aws.appstream.describe_images;

Description

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.

Table Definition

Column NameColumn Data Type
arns Input Column

The ARNs of the public, private, and shared images to describe.

VARCHAR[]
Show child fields
arns[]
names Input Column

The names of the public or private images to describe.

VARCHAR[]
Show child fields
names[]
type Input Column

The type of image (public, private, or shared) to describe. 

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.

applications

The applications associated with the image.

STRUCT(
    "name" VARCHAR,
    "display_name" VARCHAR,
    "icon_url" VARCHAR,
    "launch_path" VARCHAR,
    "launch_parameters" VARCHAR,
    "enabled" BOOLEAN,
    "metadata" MAP(VARCHAR, VARCHAR),
    "working_directory" VARCHAR,
    "description" VARCHAR,
    "arn" VARCHAR,
    "app_block_arn" VARCHAR,
    "icon_s3_location" STRUCT(
        "s3_bucket" VARCHAR,
        "s3_key" VARCHAR
    ),
    "platforms" VARCHAR[],
    "instance_families" VARCHAR[],
    "created_time" TIMESTAMP_S
)[]
Show child fields
applications[]
Show child fields
applications[].app_block_arn

The app block ARN of the application.

applications[].arn

The ARN of the application.

applications[].created_time

The time at which the application was created within the app block.

applications[].description

The description of the application.

applications[].display_name

The application name to display.

applications[].enabled

If there is a problem, the application can be disabled after image creation.

applications[].icon_s3_location

The S3 location of the application icon.

Show child fields
applications[].icon_s3_location.s3_bucket

The S3 bucket of the S3 object.

applications[].icon_s3_location.s3_key

The S3 key of the S3 object.

This is required when used for the following:

  • IconS3Location (Actions: CreateApplication and UpdateApplication)

  • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

  • ScriptDetails (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

applications[].icon_url

The URL for the application icon. This URL might be time-limited.

applications[].instance_families[]
applications[].launch_parameters

The arguments that are passed to the application at launch.

applications[].launch_path

The path to the application executable in the instance.

applications[].metadata

Additional attributes that describe the application.

applications[].name

The name of the application.

applications[].platforms[]
applications[].working_directory

The working directory for the application.

appstream_agent_version

The version of the AppStream 2.0 agent to use for instances that are launched from this image. 

VARCHAR
arn

The ARN of the image.

VARCHAR
base_image_arn

The ARN of the image from which this image was created.

VARCHAR
created_time

The time the image was created.

TIMESTAMP_S
description

The description to display.

VARCHAR
display_name

The image name to display.

VARCHAR
dynamic_app_providers_enabled

Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.

VARCHAR
image_builder_name

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

VARCHAR
image_builder_supported

Indicates whether an image builder can be launched from this image.

BOOLEAN
image_errors

Describes the errors that are returned when a new image can't be created.

STRUCT(
    "error_code" VARCHAR,
    "error_message" VARCHAR,
    "error_timestamp" TIMESTAMP_S
)[]
Show child fields
image_errors[]
Show child fields
image_errors[].error_code

The error code.

image_errors[].error_message

The error message.

image_errors[].error_timestamp

The time the error occurred.

image_permissions

The permissions to provide to the destination AWS account for the specified image.

STRUCT(
    "allow_fleet" BOOLEAN,
    "allow_image_builder" BOOLEAN
)
Show child fields
image_permissions.allow_fleet

Indicates whether the image can be used for a fleet.

image_permissions.allow_image_builder

Indicates whether the image can be used for an image builder.

image_shared_with_others

Indicates whether the image is shared with another account ID.

VARCHAR
latest_appstream_agent_version

Indicates whether the image is using the latest AppStream 2.0 agent version or not.

VARCHAR
name

The name of the image.

VARCHAR
platform

The operating system platform of the image.

VARCHAR
public_base_image_released_date

The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

TIMESTAMP_S
state

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

VARCHAR
state_change_reason

The reason why the last state change occurred.

STRUCT(
    "code" VARCHAR,
    "message" VARCHAR
)
Show child fields
state_change_reason.code

The state change reason code.

state_change_reason.message

The state change reason message.

supported_instance_families

The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:

  • General Purpose

  • Compute Optimized

  • Memory Optimized

  • Graphics

  • Graphics Design

  • Graphics Pro

  • Graphics G4

  • Graphics G5

VARCHAR[]
Show child fields
supported_instance_families[]
visibility

Indicates whether the image is public or private.

VARCHAR