LicenseManager / Client / create_license_manager_report_generator

create_license_manager_report_generator

LicenseManager.Client.create_license_manager_report_generator(**kwargs)

Creates a report generator.

See also: AWS API Documentation

Request Syntax

response = client.create_license_manager_report_generator(
    ReportGeneratorName='string',
    Type=[
        'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport'|'LicenseAssetGroupUsageReport',
    ],
    ReportContext={
        'licenseConfigurationArns': [
            'string',
        ],
        'licenseAssetGroupArns': [
            'string',
        ],
        'reportStartDate': datetime(2015, 1, 1),
        'reportEndDate': datetime(2015, 1, 1)
    },
    ReportFrequency={
        'value': 123,
        'period': 'DAY'|'WEEK'|'MONTH'|'ONE_TIME'
    },
    ClientToken='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ReportGeneratorName (string) –

  [REQUIRED]

  Name of the report generator.

• Type (list) –

  [REQUIRED]

  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.

  • (string) –

• ReportContext (dict) –

  [REQUIRED]

  Defines the type of license configuration the report generator tracks.

  • licenseConfigurationArns (list) –

    Amazon Resource Name (ARN) of the license configuration that this generator reports on.

    • (string) –

  • licenseAssetGroupArns (list) –

    Amazon Resource Names (ARNs) of the license asset groups to include in the report.

    • (string) –

  • reportStartDate (datetime) –

    Start date for the report data collection period.

  • reportEndDate (datetime) –

    End date for the report data collection period.

• ReportFrequency (dict) –

  [REQUIRED]

  Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.

  • value (integer) –

    Number of times within the frequency period that a report is generated. The only supported value is 1.

  • period (string) –

    Time period between each report. The period can be daily, weekly, or monthly.

• ClientToken (string) –

  [REQUIRED]

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• Description (string) – Description of the report generator.

• Tags (list) –

  Tags to add to the report generator.

  • (dict) –

    Details about the tags for a resource. For more information about tagging support in License Manager, see the TagResource operation.

    • Key (string) –

      The tag key.

    • Value (string) –

      The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'LicenseManagerReportGeneratorArn': 'string'
}

Response Structure

• (dict) –

  • LicenseManagerReportGeneratorArn (string) –

    The Amazon Resource Name (ARN) of the new report generator.

Exceptions

• LicenseManager.Client.exceptions.ValidationException

• LicenseManager.Client.exceptions.InvalidParameterValueException

• LicenseManager.Client.exceptions.ResourceLimitExceededException

• LicenseManager.Client.exceptions.ServerInternalException

• LicenseManager.Client.exceptions.AuthorizationException

• LicenseManager.Client.exceptions.RateLimitExceededException

• LicenseManager.Client.exceptions.AccessDeniedException

• LicenseManager.Client.exceptions.ResourceNotFoundException