describe_applications

AppStream.Client.describe_applications(**kwargs)

Retrieves a list that describes one or more applications.

See also: AWS API Documentation

Request Syntax

response = client.describe_applications(
    Arns=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)

Parameters

• Arns (list) --

  The ARNs for the applications.

  • (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

{
    'Applications': [
        {
            'Name': 'string',
            'DisplayName': 'string',
            'IconURL': 'string',
            'LaunchPath': 'string',
            'LaunchParameters': 'string',
            'Enabled': True|False,
            'Metadata': {
                'string': 'string'
            },
            'WorkingDirectory': 'string',
            'Description': 'string',
            'Arn': 'string',
            'AppBlockArn': 'string',
            'IconS3Location': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            },
            'Platforms': [
                'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
            ],
            'InstanceFamilies': [
                'string',
            ],
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Applications (list) --

    The applications in the list.

    • (dict) --

      Describes an application in the application catalog.

      • Name (string) --

        The name of the application.

      • DisplayName (string) --

        The application name to display.

      • IconURL (string) --

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

      • LaunchPath (string) --

        The path to the application executable in the instance.

      • LaunchParameters (string) --

        The arguments that are passed to the application at launch.

      • Enabled (boolean) --

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

      • Metadata (dict) --

        Additional attributes that describe the application.

        • (string) --
          • (string) --

      • WorkingDirectory (string) --

        The working directory for the application.

      • Description (string) --

        The description of the application.

      • Arn (string) --

        The ARN of the application.

      • AppBlockArn (string) --

        The app block ARN of the application.

      • IconS3Location (dict) --

        The S3 location of the application icon.

        • S3Bucket (string) --

          The S3 bucket of the S3 object.

        • S3Key (string) --

          The S3 key of the S3 object.

      • Platforms (list) --

        The platforms on which the application can run.

        • (string) --

      • InstanceFamilies (list) --

        The instance families for the application.

        • (string) --

      • CreatedTime (datetime) --

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

  • NextToken (string) --

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

Exceptions

• AppStream.Client.exceptions.OperationNotPermittedException
• AppStream.Client.exceptions.ResourceNotFoundException