AppStream / Client / describe_app_license_usage

describe_app_license_usage

AppStream.Client.describe_app_license_usage(**kwargs)

Retrieves license included application usage information.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_license_usage(
    BillingPeriod='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • BillingPeriod (string) –

    [REQUIRED]

    Billing period for the usage record.

    Specify the value in yyyy-mm format. For example, for August 2025, use 2025-08.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – Token for pagination of results.

Return type:

dict

Returns:

Response Syntax

{
    'AppLicenseUsages': [
        {
            'UserArn': 'string',
            'BillingPeriod': 'string',
            'OwnerAWSAccountId': 'string',
            'SubscriptionFirstUsedDate': datetime(2015, 1, 1),
            'SubscriptionLastUsedDate': datetime(2015, 1, 1),
            'LicenseType': 'string',
            'UserId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AppLicenseUsages (list) –

      Collection of license usage records.

      • (dict) –

        The collection of license usage records.

        • UserArn (string) –

          The ARN of the user who used the license-included application.

        • BillingPeriod (string) –

          The billing period for the license usage record.

        • OwnerAWSAccountId (string) –

          The account ID of the owner of the license.

        • SubscriptionFirstUsedDate (datetime) –

          The date and time when the license was first used.

        • SubscriptionLastUsedDate (datetime) –

          The date and time when the license was last used.

        • LicenseType (string) –

          The type of license (for example, Microsoft Office).

        • UserId (string) –

          The ID of the user who used the license-included application.

    • NextToken (string) –

      Token for pagination of results.

Exceptions

  • AppStream.Client.exceptions.InvalidParameterCombinationException

  • AppStream.Client.exceptions.OperationNotPermittedException

  • AppStream.Client.exceptions.ResourceNotFoundException