LicenseManager / Client / list_license_manager_report_generators

list_license_manager_report_generators#

LicenseManager.Client.list_license_manager_report_generators(**kwargs)#

Lists the report generators for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_license_manager_report_generators(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Filters (list) –

    Filters to scope the results. The following filters are supported:

    • LicenseConfigurationArn

    • (dict) –

      A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      • Name (string) –

        Name of the filter. Filter names are case-sensitive.

      • Values (list) –

        The value of the filter, which is case-sensitive. You can only specify one value for the filter.

        • (string) –

  • NextToken (string) – Token for the next set of results.

  • MaxResults (integer) – Maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'ReportGenerators': [
        {
            'ReportGeneratorName': 'string',
            'ReportType': [
                'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport',
            ],
            'ReportContext': {
                'licenseConfigurationArns': [
                    'string',
                ]
            },
            'ReportFrequency': {
                'value': 123,
                'period': 'DAY'|'WEEK'|'MONTH'
            },
            'LicenseManagerReportGeneratorArn': 'string',
            'LastRunStatus': 'string',
            'LastRunFailureReason': 'string',
            'LastReportGenerationTime': 'string',
            'ReportCreatorAccount': 'string',
            'Description': 'string',
            'S3Location': {
                'bucket': 'string',
                'keyPrefix': 'string'
            },
            'CreateTime': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ReportGenerators (list) –

      A report generator that creates periodic reports about your license configurations.

      • (dict) –

        Describe the details of a report generator.

        • ReportGeneratorName (string) –

          Name of the report generator.

        • ReportType (list) –

          Type of reports that are generated.

          • (string) –

        • ReportContext (dict) –

          License configuration type for this generator.

          • licenseConfigurationArns (list) –

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

            • (string) –

        • ReportFrequency (dict) –

          Details about how frequently reports are generated.

          • 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.

        • LicenseManagerReportGeneratorArn (string) –

          Amazon Resource Name (ARN) of the report generator.

        • LastRunStatus (string) –

          Status of the last report generation attempt.

        • LastRunFailureReason (string) –

          Failure message for the last report generation attempt.

        • LastReportGenerationTime (string) –

          Time the last report was generated at.

        • ReportCreatorAccount (string) –

          The Amazon Web Services account ID used to create the report generator.

        • Description (string) –

          Description of the report generator.

        • S3Location (dict) –

          Details of the S3 bucket that report generator reports are published to.

          • bucket (string) –

            Name of the S3 bucket reports are published to.

          • keyPrefix (string) –

            Prefix of the S3 bucket reports are published to.

        • CreateTime (string) –

          Time the report was created.

        • Tags (list) –

          Tags associated with the report generator.

          • (dict) –

            Details about a tag for a license configuration.

            • Key (string) –

              Tag key.

            • Value (string) –

              Tag value.

    • NextToken (string) –

      Token for the next set of results.

Exceptions