:doc:`LicenseManager <../../license-manager>` / Client / create_license_manager_report_generator

***************************************
create_license_manager_report_generator
***************************************



.. py:method:: LicenseManager.Client.create_license_manager_report_generator(**kwargs)

  

  Creates a report generator.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateLicenseManagerReportGenerator>`_  


  **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'
            },
        ]
    )
    
  :type ReportGeneratorName: string
  :param ReportGeneratorName: **[REQUIRED]** 

    Name of the report generator.

    

  
  :type Type: list
  :param Type: **[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) --* 

    

  :type ReportContext: dict
  :param ReportContext: **[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.

      

    
  
  :type ReportFrequency: dict
  :param ReportFrequency: **[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.

      

    
  
  :type ClientToken: string
  :param ClientToken: **[REQUIRED]** 

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

    

  
  :type Description: string
  :param Description: 

    Description of the report generator.

    

  
  :type Tags: list
  :param Tags: 

    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 <https://docs.aws.amazon.com/license-manager/latest/APIReference/API_TagResource.html>`__ operation.

      

    
      - **Key** *(string) --* 

        The tag key.

        

      
      - **Value** *(string) --* 

        The tag value.

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'LicenseManagerReportGeneratorArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **LicenseManagerReportGeneratorArn** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`LicenseManager.Client.exceptions.ValidationException`

  
  *   :py:class:`LicenseManager.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`LicenseManager.Client.exceptions.ResourceLimitExceededException`

  
  *   :py:class:`LicenseManager.Client.exceptions.ServerInternalException`

  
  *   :py:class:`LicenseManager.Client.exceptions.AuthorizationException`

  
  *   :py:class:`LicenseManager.Client.exceptions.RateLimitExceededException`

  
  *   :py:class:`LicenseManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`LicenseManager.Client.exceptions.ResourceNotFoundException`

  