Skip to content

UsageReportSubscription

Source code in docs_src/capo_appstream/types/usage_report_subscription.py
class UsageReportSubscription(TypedDict, closed=True):
    s3_bucket_name: NotRequired["capo_appstream.types.string.String"]
    """<p>The Amazon S3 bucket where generated reports are stored.</p> <p>If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, WorkSpaces Applications 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, WorkSpaces Applications uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, WorkSpaces Applications creates a new S3 bucket.</p>"""
    schedule: NotRequired[
        "capo_appstream.types.usage_report_schedule.UsageReportSchedule"
    ]
    """<p>The schedule for generating usage reports.</p>"""
    last_generated_report_date: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The time when the last usage report was generated.</p>"""
    subscription_errors: NotRequired[
        "capo_appstream.types.last_report_generation_execution_errors.LastReportGenerationExecutionErrors"
    ]
    """<p>The errors that were returned if usage reports couldn't be generated.</p>"""

last_generated_report_date instance-attribute

last_generated_report_date: NotRequired[Timestamp]

The time when the last usage report was generated.

s3_bucket_name instance-attribute

s3_bucket_name: NotRequired[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, WorkSpaces Applications 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, WorkSpaces Applications uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, WorkSpaces Applications creates a new S3 bucket.

schedule instance-attribute

schedule: NotRequired[UsageReportSchedule]

The schedule for generating usage reports.

subscription_errors instance-attribute

subscription_errors: NotRequired[LastReportGenerationExecutionErrors]

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