Skip to content

aws.appstream.describe_app_blocks

Example SQL Queries

SELECT * FROM
aws.appstream.describe_app_blocks;

Description

Retrieves a list that describes one or more app blocks.

Table Definition

Column NameColumn Data Type
arns Input Column

The ARNs of the app blocks.

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

The maximum size of each page of results.

BIGINT
next_token Input Column

The pagination token used to retrieve the next page of results for this operation.

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.

app_blocks

The app blocks in the list.

STRUCT(
"name" VARCHAR,
"arn" VARCHAR,
"description" VARCHAR,
"display_name" VARCHAR,
"source_s3_location" STRUCT(
"s3_bucket" VARCHAR,
"s3_key" VARCHAR
),
"setup_script_details" STRUCT(
"script_s3_location" STRUCT(
"s3_bucket" VARCHAR,
"s3_key" VARCHAR
),
"executable_path" VARCHAR,
"executable_parameters" VARCHAR,
"timeout_in_seconds" BIGINT
),
"created_time" TIMESTAMP_S,
"post_setup_script_details" STRUCT(
"script_s3_location" STRUCT(
"s3_bucket" VARCHAR,
"s3_key" VARCHAR
),
"executable_path" VARCHAR,
"executable_parameters" VARCHAR,
"timeout_in_seconds" BIGINT
),
"packaging_type" VARCHAR,
"state" VARCHAR,
"app_block_errors" STRUCT(
"error_code" VARCHAR,
"error_message" VARCHAR
)[]
)[]
Show child fields
app_blocks[]
Show child fields
app_blocks[].app_block_errors[]
Show child fields
app_blocks[].app_block_errors[].error_code

The error code.

app_blocks[].app_block_errors[].error_message

The error message.

app_blocks[].arn

The ARN of the app block.

app_blocks[].created_time

The created time of the app block.

app_blocks[].description

The description of the app block.

app_blocks[].display_name

The display name of the app block.

app_blocks[].name

The name of the app block.

app_blocks[].packaging_type

The packaging type of the app block.

app_blocks[].post_setup_script_details

The post setup script details of the app block.

This only applies to app blocks with PackagingType APPSTREAM2.

Show child fields
app_blocks[].post_setup_script_details.executable_parameters

The runtime parameters passed to the run path for the script.

app_blocks[].post_setup_script_details.executable_path

The run path for the script.

app_blocks[].post_setup_script_details.script_s3_location

The S3 object location for the script.

Show child fields
app_blocks[].post_setup_script_details.script_s3_location.s3_bucket

The S3 bucket of the S3 object.

app_blocks[].post_setup_script_details.script_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)

app_blocks[].post_setup_script_details.timeout_in_seconds

The run timeout, in seconds, for the script.

app_blocks[].setup_script_details

The setup script details of the app block.

This only applies to app blocks with PackagingType CUSTOM.

Show child fields
app_blocks[].setup_script_details.executable_parameters

The runtime parameters passed to the run path for the script.

app_blocks[].setup_script_details.executable_path

The run path for the script.

app_blocks[].setup_script_details.script_s3_location

The S3 object location for the script.

Show child fields
app_blocks[].setup_script_details.script_s3_location.s3_bucket

The S3 bucket of the S3 object.

app_blocks[].setup_script_details.script_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)

app_blocks[].setup_script_details.timeout_in_seconds

The run timeout, in seconds, for the script.

app_blocks[].source_s3_location

The source S3 location of the app block.

Show child fields
app_blocks[].source_s3_location.s3_bucket

The S3 bucket of the S3 object.

app_blocks[].source_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)

app_blocks[].state

The state of the app block.

An app block with AppStream 2.0 packaging will be in the INACTIVE state if no application package (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block, it becomes ACTIVE.

Custom app blocks are always in the ACTIVE state and no action is required to use them.