AppStream / Client / create_usage_report_subscription

create_usage_report_subscription

AppStream.Client.create_usage_report_subscription()

Creates a usage report subscription. Usage reports are generated daily.

See also: AWS API Documentation

Request Syntax

response = client.create_usage_report_subscription()
Return type:

dict

Returns:

Response Syntax

{
    'S3BucketName': 'string',
    'Schedule': 'DAILY'
}

Response Structure

  • (dict) –

    • 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, 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 (string) –

      The schedule for generating usage reports.

Exceptions

  • AppStream.Client.exceptions.InvalidRoleException

  • AppStream.Client.exceptions.InvalidAccountStatusException

  • AppStream.Client.exceptions.LimitExceededException