AppStream / Client / describe_app_blocks

describe_app_blocks#

AppStream.Client.describe_app_blocks(**kwargs)#

Retrieves a list that describes one or more app blocks.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_blocks(
    Arns=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Arns (list) –

    The ARNs of the app blocks.

    • (string) –

  • NextToken (string) – The pagination token used to retrieve the next page of results for this operation.

  • MaxResults (integer) – The maximum size of each page of results.

Return type:

dict

Returns:

Response Syntax

{
    'AppBlocks': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Description': 'string',
            'DisplayName': 'string',
            'SourceS3Location': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            },
            'SetupScriptDetails': {
                'ScriptS3Location': {
                    'S3Bucket': 'string',
                    'S3Key': 'string'
                },
                'ExecutablePath': 'string',
                'ExecutableParameters': 'string',
                'TimeoutInSeconds': 123
            },
            'CreatedTime': datetime(2015, 1, 1),
            'PostSetupScriptDetails': {
                'ScriptS3Location': {
                    'S3Bucket': 'string',
                    'S3Key': 'string'
                },
                'ExecutablePath': 'string',
                'ExecutableParameters': 'string',
                'TimeoutInSeconds': 123
            },
            'PackagingType': 'CUSTOM'|'APPSTREAM2',
            'State': 'INACTIVE'|'ACTIVE',
            'AppBlockErrors': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AppBlocks (list) –

      The app blocks in the list.

      • (dict) –

        Describes an app block.

        App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.

        This is only supported for Elastic fleets.

        • Name (string) –

          The name of the app block.

        • Arn (string) –

          The ARN of the app block.

        • Description (string) –

          The description of the app block.

        • DisplayName (string) –

          The display name of the app block.

        • SourceS3Location (dict) –

          The source S3 location of the app block.

          • S3Bucket (string) –

            The S3 bucket of the S3 object.

          • S3Key (string) –

            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)

        • SetupScriptDetails (dict) –

          The setup script details of the app block.

          This only applies to app blocks with PackagingType CUSTOM.

          • ScriptS3Location (dict) –

            The S3 object location for the script.

            • S3Bucket (string) –

              The S3 bucket of the S3 object.

            • S3Key (string) –

              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)

          • ExecutablePath (string) –

            The run path for the script.

          • ExecutableParameters (string) –

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

          • TimeoutInSeconds (integer) –

            The run timeout, in seconds, for the script.

        • CreatedTime (datetime) –

          The created time of the app block.

        • PostSetupScriptDetails (dict) –

          The post setup script details of the app block.

          This only applies to app blocks with PackagingType APPSTREAM2.

          • ScriptS3Location (dict) –

            The S3 object location for the script.

            • S3Bucket (string) –

              The S3 bucket of the S3 object.

            • S3Key (string) –

              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)

          • ExecutablePath (string) –

            The run path for the script.

          • ExecutableParameters (string) –

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

          • TimeoutInSeconds (integer) –

            The run timeout, in seconds, for the script.

        • PackagingType (string) –

          The packaging type of the app block.

        • State (string) –

          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.

        • AppBlockErrors (list) –

          The errors of the app block.

          • (dict) –

            The error details.

            • ErrorCode (string) –

              The error code.

            • ErrorMessage (string) –

              The error message.

    • NextToken (string) –

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

Exceptions