usage_report_subscriptions

Creates, updates, deletes, gets or lists a usage_report_subscriptions resource.

Overview

Name	usage_report_subscriptions
Type	Resource
Id	aws.appstream.usage_report_subscriptions

Fields

The following fields are returned by SELECT queries:

describe_usage_report_subscriptions

Name	Datatype	Description
next_token	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.
usage_report_subscriptions	array	Information about the usage report subscription.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_usage_report_subscriptions	select	region		Retrieves a list that describes one or more usage report subscriptions.
create_usage_report_subscription	insert	region		Creates a usage report subscription. Usage reports are generated daily.
delete_usage_report_subscription	delete	region		Disables usage report generation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_usage_report_subscriptions

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

SELECT
next_token,
usage_report_subscriptions
FROM aws.appstream.usage_report_subscriptions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_usage_report_subscription

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

INSERT INTO aws.appstream.usage_report_subscriptions (
region
)
SELECT 
'{{ region }}'
RETURNING
s3_bucket_name,
schedule
;

Manifest

# Description fields are for documentation purposes
- name: usage_report_subscriptions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the usage_report_subscriptions resource.

DELETE examples

delete_usage_report_subscription

Disables usage report generation.

DELETE FROM aws.appstream.usage_report_subscriptions
WHERE region = '{{ region }}' --required
;