license_manager_report_generators

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

Overview

Name	license_manager_report_generators
Type	Resource
Id	aws.license_manager.license_manager_report_generators

Fields

The following fields are returned by SELECT queries:

get_license_manager_report_generator

Name	Datatype	Description
create_time	string	Time the report was created.
description	string	Description of the report generator.
last_report_generation_time	string	Time the last report was generated at.
last_run_failure_reason	string	Failure message for the last report generation attempt.
last_run_status	string	Status of the last report generation attempt.
license_manager_report_generator_arn	string	Amazon Resource Name (ARN) of the report generator.
report_context	object	License configuration type for this generator.
report_creator_account	string	The Amazon Web Services account ID used to create the report generator.
report_frequency	object	Details about how frequently reports are generated.
report_generator_name	string	Name of the report generator.
report_type	array	Type of reports that are generated.
s3_location	object	Details of the S3 bucket that report generator reports are published to.
tags	array	Tags associated with the report generator.

list_license_manager_report_generators

Name	Datatype	Description
next_token	string	Token for the next set of results.
report_generators	array	A report generator that creates periodic reports about your license configurations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_license_manager_report_generator	select	region		Gets information about the specified report generator.
list_license_manager_report_generators	select	region		Lists the report generators for your account.
create_license_manager_report_generator	insert	region, ReportGeneratorName, Type, ReportContext, ReportFrequency, ClientToken		Creates a report generator.
update_license_manager_report_generator	update	region, LicenseManagerReportGeneratorArn, ReportGeneratorName, Type, ReportContext, ReportFrequency, ClientToken		Updates a report generator. After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.
delete_license_manager_report_generator	delete	region		Deletes the specified report generator. This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.

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

get_license_manager_report_generator

Gets information about the specified report generator.

SELECT
create_time,
description,
last_report_generation_time,
last_run_failure_reason,
last_run_status,
license_manager_report_generator_arn,
report_context,
report_creator_account,
report_frequency,
report_generator_name,
report_type,
s3_location,
tags
FROM aws.license_manager.license_manager_report_generators
WHERE region = '{{ region }}' -- required
;

list_license_manager_report_generators

Lists the report generators for your account.

SELECT
next_token,
report_generators
FROM aws.license_manager.license_manager_report_generators
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_license_manager_report_generator

Creates a report generator.

INSERT INTO aws.license_manager.license_manager_report_generators (
ReportGeneratorName,
Type,
ReportContext,
ReportFrequency,
ClientToken,
Description,
Tags,
region
)
SELECT 
'{{ ReportGeneratorName }}' /* required */,
'{{ Type }}' /* required */,
'{{ ReportContext }}' /* required */,
'{{ ReportFrequency }}' /* required */,
'{{ ClientToken }}' /* required */,
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
license_manager_report_generator_arn
;

Manifest

# Description fields are for documentation purposes
- name: license_manager_report_generators
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the license_manager_report_generators resource.
  - name: ReportGeneratorName
    value: "{{ ReportGeneratorName }}"
    description: |
      Name of the report generator.
  - name: Type
    value:
      - "{{ Type }}"
    description: |
      Type of reports to generate. The following report types an be generated: License configuration report - Reports the number and details of consumed licenses for a license configuration. Resource report - Reports the tracked licenses and resource consumption for a license configuration.
  - name: ReportContext
    description: |
      Defines the type of license configuration the report generator tracks.
    value:
      licenseConfigurationArns:
        - "{{ licenseConfigurationArns }}"
      licenseAssetGroupArns:
        - "{{ licenseAssetGroupArns }}"
      reportStartDate: "{{ reportStartDate }}"
      reportEndDate: "{{ reportEndDate }}"
  - name: ReportFrequency
    description: |
      Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.
    value:
      value: {{ value }}
      period: "{{ period }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - name: Description
    value: "{{ Description }}"
    description: |
      Description of the report generator.
  - name: Tags
    description: |
      Tags to add to the report generator.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_license_manager_report_generator

Updates a report generator. After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.

UPDATE aws.license_manager.license_manager_report_generators
SET 
LicenseManagerReportGeneratorArn = '{{ LicenseManagerReportGeneratorArn }}',
ReportGeneratorName = '{{ ReportGeneratorName }}',
Type = '{{ Type }}',
ReportContext = '{{ ReportContext }}',
ReportFrequency = '{{ ReportFrequency }}',
ClientToken = '{{ ClientToken }}',
Description = '{{ Description }}'
WHERE 
region = '{{ region }}' --required
AND LicenseManagerReportGeneratorArn = '{{ LicenseManagerReportGeneratorArn }}' --required
AND ReportGeneratorName = '{{ ReportGeneratorName }}' --required
AND Type = '{{ Type }}' --required
AND ReportContext = '{{ ReportContext }}' --required
AND ReportFrequency = '{{ ReportFrequency }}' --required
AND ClientToken = '{{ ClientToken }}' --required;

DELETE examples

delete_license_manager_report_generator

Deletes the specified report generator. This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.

DELETE FROM aws.license_manager.license_manager_report_generators
WHERE region = '{{ region }}' --required
;