AWS API Changes

2021/05/18 - AWS License Manager - 5 new api methods

Changes AWS License Manager now supports periodic report generation.

UpdateLicenseManagerReportGenerator (new)

Updates a report generator.

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

Request Syntax

client.update_license_manager_report_generator(
    LicenseManagerReportGeneratorArn='string',
    ReportGeneratorName='string',
    Type=[
        'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport',
    ],
    ReportContext={
        'licenseConfigurationArns': [
            'string',
        ]
    },
    ReportFrequency={
        'value': 123,
        'period': 'DAY'|'WEEK'|'MONTH'
    },
    ClientToken='string',
    Description='string'
)

type LicenseManagerReportGeneratorArn

string

param LicenseManagerReportGeneratorArn

[REQUIRED]

Amazon Resource Number (ARN) of the report generator to update.

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 on the number and details of consumed licenses for a license configuration.
Resource report - Reports on the tracked licenses and resource consumption for a license configuration.

(string) --

type ReportContext

dict

param ReportContext

[REQUIRED]

licenseConfigurationArns (list) -- [REQUIRED]

Amazon Resource Number (ARN) of the license configuration that this generator reports on.
- (string) --

type ReportFrequency

dict

param ReportFrequency

[REQUIRED]

Frequency by which reports are generated. The following options are avaiable:

??? What are the APi value options?

value (integer) --

Number of times within the frequency period that a report will be generated. Currently only 1 is supported.
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.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListLicenseManagerReportGenerators (new)

Link ¶

Lists the report generators for your account.

See also: AWS API Documentation

Request Syntax

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

type Filters

list

param Filters

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) --
  
  Filter values. Filter values are case-sensitive.
  - (string) --

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

rtype

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 on 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 this generator reports on.
      - licenseConfigurationArns (list) --
        
        Amazon Resource Number (ARN) of the license configuration that this generator reports on.
        
        (string) --
    - ReportFrequency (dict) --
      
      Details on how frequently reports are generated.
      - value (integer) --
        
        Number of times within the frequency period that a report will be generated. Currently only 1 is supported.
      - period (string) --
        
        Time period between each report. The period can be daily, weekly, or monthly.
    - LicenseManagerReportGeneratorArn (string) --
      
      Amazon Resource Number (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 AWS 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.

CreateLicenseManagerReportGenerator (new)

Link ¶

Creates a new report generator.

See also: AWS API Documentation

Request Syntax

client.create_license_manager_report_generator(
    ReportGeneratorName='string',
    Type=[
        'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport',
    ],
    ReportContext={
        'licenseConfigurationArns': [
            'string',
        ]
    },
    ReportFrequency={
        'value': 123,
        'period': 'DAY'|'WEEK'|'MONTH'
    },
    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 on the number and details of consumed licenses for a license configuration.
Resource report - Reports on 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) -- [REQUIRED]

Amazon Resource Number (ARN) of the license configuration that this generator reports on.
- (string) --

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 will be generated. Currently only 1 is supported.
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 a tag for a license configuration.
- Key (string) --
  
  Tag key.
- Value (string) --
  
  Tag value.

rtype

dict

returns

Response Syntax

{
    'LicenseManagerReportGeneratorArn': 'string'
}

Response Structure

(dict) --
- LicenseManagerReportGeneratorArn (string) --
  
  The Amazon Resource Number (ARN) of the new report generator.

GetLicenseManagerReportGenerator (new)

Link ¶

Gets information on the specified report generator.

See also: AWS API Documentation

Request Syntax

client.get_license_manager_report_generator(
    LicenseManagerReportGeneratorArn='string'
)

type LicenseManagerReportGeneratorArn

string

param LicenseManagerReportGeneratorArn

[REQUIRED]

mazon Resource Number (ARN) of the report generator to retrieve information on.

rtype

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 on your license configurations.
  - ReportGeneratorName (string) --
    
    Name of the report generator.
  - ReportType (list) --
    
    Type of reports that are generated.
    - (string) --
  - ReportContext (dict) --
    
    License configuration type this generator reports on.
    - licenseConfigurationArns (list) --
      
      Amazon Resource Number (ARN) of the license configuration that this generator reports on.
      - (string) --
  - ReportFrequency (dict) --
    
    Details on how frequently reports are generated.
    - value (integer) --
      
      Number of times within the frequency period that a report will be generated. Currently only 1 is supported.
    - period (string) --
      
      Time period between each report. The period can be daily, weekly, or monthly.
  - LicenseManagerReportGeneratorArn (string) --
    
    Amazon Resource Number (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 AWS 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.

DeleteLicenseManagerReportGenerator (new)

Link ¶

Delete an existing report generator.

This action deletes the report generator, which stops it from generating future reports and cannot be reversed. However, the previous reports from this generator will remain in your S3 bucket.

See also: AWS API Documentation

Request Syntax

client.delete_license_manager_report_generator(
    LicenseManagerReportGeneratorArn='string'
)

type LicenseManagerReportGeneratorArn

string

param LicenseManagerReportGeneratorArn

[REQUIRED]

Amazon Resource Number (ARN) of the report generator that will be deleted.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --