get_license_manager_report_generator

LicenseManager.Client.get_license_manager_report_generator(**kwargs)

Gets information about the specified report generator.

See also: AWS API Documentation

Request Syntax

response = client.get_license_manager_report_generator(
    LicenseManagerReportGeneratorArn='string'
)

Parameters

LicenseManagerReportGeneratorArn (string) --

[REQUIRED]

Amazon Resource Name (ARN) of the report generator.

Return type

dict

Returns

Response Syntax

{
    'ReportGenerator': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) --
  • ReportGenerator (dict) --

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

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

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