AppStream / Client / describe_usage_report_subscriptions

describe_usage_report_subscriptions#

AppStream.Client.describe_usage_report_subscriptions(**kwargs)#

Retrieves a list that describes one or more usage report subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.describe_usage_report_subscriptions(
    MaxResults=123,
    NextToken='string'
)
Parameters:

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

  • NextToken (string) – The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Return type:

dict

Returns:

Response Syntax

{
    'UsageReportSubscriptions': [
        {
            'S3BucketName': 'string',
            'Schedule': 'DAILY',
            'LastGeneratedReportDate': datetime(2015, 1, 1),
            'SubscriptionErrors': [
                {
                    'ErrorCode': 'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • UsageReportSubscriptions (list) –

      Information about the usage report subscription.

      • (dict) –

        Describes information about the usage report subscription.

        • S3BucketName (string) –

          The Amazon S3 bucket where generated reports are stored.

          If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven’t already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

        • Schedule (string) –

          The schedule for generating usage reports.

        • LastGeneratedReportDate (datetime) –

          The time when the last usage report was generated.

        • SubscriptionErrors (list) –

          The errors that were returned if usage reports couldn’t be generated.

          • (dict) –

            Describes the error that is returned when a usage report can’t be generated.

            • ErrorCode (string) –

              The error code for the error that is returned when a usage report can’t be generated.

            • ErrorMessage (string) –

              The error message for the error that is returned when a usage report can’t be generated.

    • NextToken (string) –

      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Exceptions

  • AppStream.Client.exceptions.ResourceNotFoundException

  • AppStream.Client.exceptions.InvalidAccountStatusException