Skip to content

AppBlock

Source code in docs_src/capo_appstream/types/app_block.py
class AppBlock(TypedDict, closed=True):
    name: NotRequired["capo_appstream.types.string.String"]
    """<p>The name of the app block.</p>"""
    arn: NotRequired["capo_appstream.types.arn.Arn"]
    """<p>The ARN of the app block.</p>"""
    description: NotRequired["capo_appstream.types.string.String"]
    """<p>The description of the app block.</p>"""
    display_name: NotRequired["capo_appstream.types.string.String"]
    """<p>The display name of the app block.</p>"""
    source_s3_location: NotRequired["capo_appstream.types.s3_location.S3Location"]
    """<p>The source S3 location of the app block.</p>"""
    setup_script_details: NotRequired[
        "capo_appstream.types.script_details.ScriptDetails"
    ]
    """<p>The setup script details of the app block.</p> <p>This only applies to app blocks with PackagingType <code>CUSTOM</code>.</p>"""
    created_time: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The created time of the app block.</p>"""
    post_setup_script_details: NotRequired[
        "capo_appstream.types.script_details.ScriptDetails"
    ]
    """<p>The post setup script details of the app block.</p> <p>This only applies to app blocks with PackagingType <code>APPSTREAM2</code>.</p>"""
    packaging_type: NotRequired["capo_appstream.types.packaging_type.PackagingType"]
    """<p>The packaging type of the app block.</p>"""
    state: NotRequired["capo_appstream.types.app_block_state.AppBlockState"]
    """<p>The state of the app block.</p> <p>An app block with WorkSpaces Applications packaging will be in the <code>INACTIVE</code> 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 <code>ACTIVE</code>. </p> <p>Custom app blocks are always in the <code>ACTIVE</code> state and no action is required to use them.</p>"""
    app_block_errors: NotRequired[
        "capo_appstream.types.error_details_list.ErrorDetailsList"
    ]
    """<p>The errors of the app block.</p>"""

app_block_errors instance-attribute

app_block_errors: NotRequired[ErrorDetailsList]

The errors of the app block.

arn instance-attribute

arn: NotRequired[Arn]

The ARN of the app block.

created_time instance-attribute

created_time: NotRequired[Timestamp]

The created time of the app block.

description instance-attribute

description: NotRequired[String]

The description of the app block.

display_name instance-attribute

display_name: NotRequired[String]

The display name of the app block.

name instance-attribute

name: NotRequired[String]

The name of the app block.

packaging_type instance-attribute

packaging_type: NotRequired[PackagingType]

The packaging type of the app block.

post_setup_script_details instance-attribute

post_setup_script_details: NotRequired[ScriptDetails]

The post setup script details of the app block.

This only applies to app blocks with PackagingType APPSTREAM2.

setup_script_details instance-attribute

setup_script_details: NotRequired[ScriptDetails]

The setup script details of the app block.

This only applies to app blocks with PackagingType CUSTOM.

source_s3_location instance-attribute

source_s3_location: NotRequired[S3Location]

The source S3 location of the app block.

state instance-attribute

state: NotRequired[AppBlockState]

The state of the app block.

An app block with WorkSpaces Applications 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.