AWS License Manager

2025/11/20 - AWS License Manager - 12 new11 updated api methods

Changes  Added cross-account resource aggregation via license asset groups and expiry tracking for Self-Managed Licenses. Extended Org-Wide View to Self-Managed Licenses, added reporting for license asset groups, and removed Athena/Glue dependencies for cross-account resource discovery in commercial regions.

CreateLicenseAssetGroup (new) Link ¶

Creates a license asset group.

See also: AWS API Documentation

Request Syntax

client.create_license_asset_group(
    Name='string',
    Description='string',
    LicenseAssetGroupConfigurations=[
        {
            'UsageDimension': 'string'
        },
    ],
    AssociatedLicenseAssetRulesetARNs=[
        'string',
    ],
    Properties=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
type Name:

string

param Name:

[REQUIRED]

License asset group name.

type Description:

string

param Description:

License asset group description.

type LicenseAssetGroupConfigurations:

list

param LicenseAssetGroupConfigurations:

[REQUIRED]

License asset group configurations.

  • (dict) --

    License asset group configuration.

    • UsageDimension (string) --

      License Asset Group Configuration Usage dimension.

type AssociatedLicenseAssetRulesetARNs:

list

param AssociatedLicenseAssetRulesetARNs:

[REQUIRED]

ARNs of associated license asset rulesets.

  • (string) --

type Properties:

list

param Properties:

License asset group properties.

  • (dict) --

    License asset group property.

    • Key (string) -- [REQUIRED]

      Property key.

    • Value (string) -- [REQUIRED]

      Property value.

type Tags:

list

param Tags:

Tags to add to the license asset group.

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

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetGroupArn': 'string',
    'Status': 'string'
}

Response Structure

  • (dict) --

    • LicenseAssetGroupArn (string) --

      Amazon Resource Name (ARN) of the license asset group.

    • Status (string) --

      License asset group status.

ListLicenseAssetRulesets (new) Link ¶

Lists license asset rulesets.

See also: AWS API Documentation

Request Syntax

client.list_license_asset_rulesets(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ShowAWSManagedLicenseAssetRulesets=True|False,
    MaxResults=123,
    NextToken='string'
)
type Filters:

list

param Filters:

Filters to scope the results. Following filters are supported

  • Name

  • (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) --

type ShowAWSManagedLicenseAssetRulesets:

boolean

param ShowAWSManagedLicenseAssetRulesets:

Specifies whether to show License Manager managed license asset rulesets.

type MaxResults:

integer

param MaxResults:

Maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

Token for the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetRulesets': [
        {
            'Name': 'string',
            'Description': 'string',
            'Rules': [
                {
                    'RuleStatement': {
                        'LicenseConfigurationRuleStatement': {
                            'AndRuleStatement': {
                                'MatchingRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Constraint': 'string',
                                        'ValueToMatch': [
                                            'string',
                                        ]
                                    },
                                ],
                                'ScriptRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Script': 'string'
                                    },
                                ]
                            },
                            'OrRuleStatement': {
                                'MatchingRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Constraint': 'string',
                                        'ValueToMatch': [
                                            'string',
                                        ]
                                    },
                                ],
                                'ScriptRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Script': 'string'
                                    },
                                ]
                            },
                            'MatchingRuleStatement': {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            }
                        },
                        'LicenseRuleStatement': {
                            'AndRuleStatement': {
                                'MatchingRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Constraint': 'string',
                                        'ValueToMatch': [
                                            'string',
                                        ]
                                    },
                                ],
                                'ScriptRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Script': 'string'
                                    },
                                ]
                            },
                            'OrRuleStatement': {
                                'MatchingRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Constraint': 'string',
                                        'ValueToMatch': [
                                            'string',
                                        ]
                                    },
                                ],
                                'ScriptRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Script': 'string'
                                    },
                                ]
                            },
                            'MatchingRuleStatement': {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            }
                        },
                        'InstanceRuleStatement': {
                            'AndRuleStatement': {
                                'MatchingRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Constraint': 'string',
                                        'ValueToMatch': [
                                            'string',
                                        ]
                                    },
                                ],
                                'ScriptRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Script': 'string'
                                    },
                                ]
                            },
                            'OrRuleStatement': {
                                'MatchingRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Constraint': 'string',
                                        'ValueToMatch': [
                                            'string',
                                        ]
                                    },
                                ],
                                'ScriptRuleStatements': [
                                    {
                                        'KeyToMatch': 'string',
                                        'Script': 'string'
                                    },
                                ]
                            },
                            'MatchingRuleStatement': {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                            'ScriptRuleStatement': {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            }
                        }
                    }
                },
            ],
            'LicenseAssetRulesetArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseAssetRulesets (list) --

      License asset rulesets.

      • (dict) --

        License asset ruleset.

        • Name (string) --

          License asset ruleset name.

        • Description (string) --

          License asset ruleset description.

        • Rules (list) --

          License asset rules.

          • (dict) --

            License asset rule.

            • RuleStatement (dict) --

              Rule statement.

              • LicenseConfigurationRuleStatement (dict) --

                License configuration rule statement.

                • AndRuleStatement (dict) --

                  AND rule statement.

                  • MatchingRuleStatements (list) --

                    Matching rule statements.

                    • (dict) --

                      Matching rule statement.

                      • KeyToMatch (string) --

                        Key to match.

                        The following keys and are supported when the RuleStatement type is Instance:

                        • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                        • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                        • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                        • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                        • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License:

                        • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                        • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License Configuration:

                        • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • Constraint (string) --

                        Constraint.

                      • ValueToMatch (list) --

                        Value to match.

                        • (string) --

                  • ScriptRuleStatements (list) --

                    Script rule statements.

                    • (dict) --

                      Rule statement that uses a script to evaluate license asset conditions.

                      • KeyToMatch (string) --

                        Key name to match against in the script rule evaluation.

                      • Script (string) --

                        Script code used to evaluate the rule condition.

                • OrRuleStatement (dict) --

                  OR rule statement.

                  • MatchingRuleStatements (list) --

                    Matching rule statements.

                    • (dict) --

                      Matching rule statement.

                      • KeyToMatch (string) --

                        Key to match.

                        The following keys and are supported when the RuleStatement type is Instance:

                        • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                        • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                        • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                        • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                        • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License:

                        • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                        • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License Configuration:

                        • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • Constraint (string) --

                        Constraint.

                      • ValueToMatch (list) --

                        Value to match.

                        • (string) --

                  • ScriptRuleStatements (list) --

                    Script rule statements.

                    • (dict) --

                      Rule statement that uses a script to evaluate license asset conditions.

                      • KeyToMatch (string) --

                        Key name to match against in the script rule evaluation.

                      • Script (string) --

                        Script code used to evaluate the rule condition.

                • MatchingRuleStatement (dict) --

                  Matching rule statement.

                  • KeyToMatch (string) --

                    Key to match.

                    The following keys and are supported when the RuleStatement type is Instance:

                    • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                    • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                    • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                    • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                    • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                    • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                    • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                    • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                    The following keys and are supported when the RuleStatement type is License:

                    • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                    • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                    The following keys and are supported when the RuleStatement type is License Configuration:

                    • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                  • Constraint (string) --

                    Constraint.

                  • ValueToMatch (list) --

                    Value to match.

                    • (string) --

              • LicenseRuleStatement (dict) --

                License rule statement.

                • AndRuleStatement (dict) --

                  AND rule statement.

                  • MatchingRuleStatements (list) --

                    Matching rule statements.

                    • (dict) --

                      Matching rule statement.

                      • KeyToMatch (string) --

                        Key to match.

                        The following keys and are supported when the RuleStatement type is Instance:

                        • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                        • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                        • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                        • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                        • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License:

                        • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                        • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License Configuration:

                        • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • Constraint (string) --

                        Constraint.

                      • ValueToMatch (list) --

                        Value to match.

                        • (string) --

                  • ScriptRuleStatements (list) --

                    Script rule statements.

                    • (dict) --

                      Rule statement that uses a script to evaluate license asset conditions.

                      • KeyToMatch (string) --

                        Key name to match against in the script rule evaluation.

                      • Script (string) --

                        Script code used to evaluate the rule condition.

                • OrRuleStatement (dict) --

                  OR rule statement.

                  • MatchingRuleStatements (list) --

                    Matching rule statements.

                    • (dict) --

                      Matching rule statement.

                      • KeyToMatch (string) --

                        Key to match.

                        The following keys and are supported when the RuleStatement type is Instance:

                        • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                        • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                        • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                        • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                        • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License:

                        • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                        • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License Configuration:

                        • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • Constraint (string) --

                        Constraint.

                      • ValueToMatch (list) --

                        Value to match.

                        • (string) --

                  • ScriptRuleStatements (list) --

                    Script rule statements.

                    • (dict) --

                      Rule statement that uses a script to evaluate license asset conditions.

                      • KeyToMatch (string) --

                        Key name to match against in the script rule evaluation.

                      • Script (string) --

                        Script code used to evaluate the rule condition.

                • MatchingRuleStatement (dict) --

                  Matching rule statement.

                  • KeyToMatch (string) --

                    Key to match.

                    The following keys and are supported when the RuleStatement type is Instance:

                    • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                    • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                    • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                    • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                    • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                    • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                    • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                    • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                    The following keys and are supported when the RuleStatement type is License:

                    • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                    • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                    The following keys and are supported when the RuleStatement type is License Configuration:

                    • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                  • Constraint (string) --

                    Constraint.

                  • ValueToMatch (list) --

                    Value to match.

                    • (string) --

              • InstanceRuleStatement (dict) --

                Instance rule statement.

                • AndRuleStatement (dict) --

                  AND rule statement.

                  • MatchingRuleStatements (list) --

                    Matching rule statements.

                    • (dict) --

                      Matching rule statement.

                      • KeyToMatch (string) --

                        Key to match.

                        The following keys and are supported when the RuleStatement type is Instance:

                        • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                        • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                        • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                        • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                        • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License:

                        • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                        • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License Configuration:

                        • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • Constraint (string) --

                        Constraint.

                      • ValueToMatch (list) --

                        Value to match.

                        • (string) --

                  • ScriptRuleStatements (list) --

                    Script rule statements.

                    • (dict) --

                      Rule statement that uses a script to evaluate license asset conditions.

                      • KeyToMatch (string) --

                        Key name to match against in the script rule evaluation.

                      • Script (string) --

                        Script code used to evaluate the rule condition.

                • OrRuleStatement (dict) --

                  OR rule statement.

                  • MatchingRuleStatements (list) --

                    Matching rule statements.

                    • (dict) --

                      Matching rule statement.

                      • KeyToMatch (string) --

                        Key to match.

                        The following keys and are supported when the RuleStatement type is Instance:

                        • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                        • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                        • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                        • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                        • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                        • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License:

                        • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                        • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                        • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                        The following keys and are supported when the RuleStatement type is License Configuration:

                        • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                        • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • Constraint (string) --

                        Constraint.

                      • ValueToMatch (list) --

                        Value to match.

                        • (string) --

                  • ScriptRuleStatements (list) --

                    Script rule statements.

                    • (dict) --

                      Rule statement that uses a script to evaluate license asset conditions.

                      • KeyToMatch (string) --

                        Key name to match against in the script rule evaluation.

                      • Script (string) --

                        Script code used to evaluate the rule condition.

                • MatchingRuleStatement (dict) --

                  Matching rule statement.

                  • KeyToMatch (string) --

                    Key to match.

                    The following keys and are supported when the RuleStatement type is Instance:

                    • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                    • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                    • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                    • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                    • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                    • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                    • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                    • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                    The following keys and are supported when the RuleStatement type is License:

                    • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                    • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                    • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                    The following keys and are supported when the RuleStatement type is License Configuration:

                    • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                  • Constraint (string) --

                    Constraint.

                  • ValueToMatch (list) --

                    Value to match.

                    • (string) --

                • ScriptRuleStatement (dict) --

                  Script rule statement.

                  • KeyToMatch (string) --

                    Key name to match against in the script rule evaluation.

                  • Script (string) --

                    Script code used to evaluate the rule condition.

        • LicenseAssetRulesetArn (string) --

          Amazon Resource Name (ARN) of the license asset ruleset.

    • NextToken (string) --

      Token for the next set of results.

ListAssetsForLicenseAssetGroup (new) Link ¶

Lists assets for a license asset group.

See also: AWS API Documentation

Request Syntax

client.list_assets_for_license_asset_group(
    LicenseAssetGroupArn='string',
    AssetType='string',
    MaxResults=123,
    NextToken='string'
)
type LicenseAssetGroupArn:

string

param LicenseAssetGroupArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license asset group.

type AssetType:

string

param AssetType:

[REQUIRED]

Asset type. The possible values are Instance | License | LicenseConfiguration.

type MaxResults:

integer

param MaxResults:

Maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

Token for the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'Assets': [
        {
            'AssetArn': 'string',
            'LatestAssetDiscoveryTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Assets (list) --

      Assets.

      • (dict) --

        Asset.

        • AssetArn (string) --

          Amazon Resource Name (ARN) of the asset.

        • LatestAssetDiscoveryTime (datetime) --

          Latest asset discovery time.

    • NextToken (string) --

      Token for the next set of results.

GetLicenseAssetRuleset (new) Link ¶

Gets a license asset ruleset.

See also: AWS API Documentation

Request Syntax

client.get_license_asset_ruleset(
    LicenseAssetRulesetArn='string'
)
type LicenseAssetRulesetArn:

string

param LicenseAssetRulesetArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license asset ruleset.

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetRuleset': {
        'Name': 'string',
        'Description': 'string',
        'Rules': [
            {
                'RuleStatement': {
                    'LicenseConfigurationRuleStatement': {
                        'AndRuleStatement': {
                            'MatchingRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Constraint': 'string',
                                    'ValueToMatch': [
                                        'string',
                                    ]
                                },
                            ],
                            'ScriptRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Script': 'string'
                                },
                            ]
                        },
                        'OrRuleStatement': {
                            'MatchingRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Constraint': 'string',
                                    'ValueToMatch': [
                                        'string',
                                    ]
                                },
                            ],
                            'ScriptRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Script': 'string'
                                },
                            ]
                        },
                        'MatchingRuleStatement': {
                            'KeyToMatch': 'string',
                            'Constraint': 'string',
                            'ValueToMatch': [
                                'string',
                            ]
                        }
                    },
                    'LicenseRuleStatement': {
                        'AndRuleStatement': {
                            'MatchingRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Constraint': 'string',
                                    'ValueToMatch': [
                                        'string',
                                    ]
                                },
                            ],
                            'ScriptRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Script': 'string'
                                },
                            ]
                        },
                        'OrRuleStatement': {
                            'MatchingRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Constraint': 'string',
                                    'ValueToMatch': [
                                        'string',
                                    ]
                                },
                            ],
                            'ScriptRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Script': 'string'
                                },
                            ]
                        },
                        'MatchingRuleStatement': {
                            'KeyToMatch': 'string',
                            'Constraint': 'string',
                            'ValueToMatch': [
                                'string',
                            ]
                        }
                    },
                    'InstanceRuleStatement': {
                        'AndRuleStatement': {
                            'MatchingRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Constraint': 'string',
                                    'ValueToMatch': [
                                        'string',
                                    ]
                                },
                            ],
                            'ScriptRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Script': 'string'
                                },
                            ]
                        },
                        'OrRuleStatement': {
                            'MatchingRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Constraint': 'string',
                                    'ValueToMatch': [
                                        'string',
                                    ]
                                },
                            ],
                            'ScriptRuleStatements': [
                                {
                                    'KeyToMatch': 'string',
                                    'Script': 'string'
                                },
                            ]
                        },
                        'MatchingRuleStatement': {
                            'KeyToMatch': 'string',
                            'Constraint': 'string',
                            'ValueToMatch': [
                                'string',
                            ]
                        },
                        'ScriptRuleStatement': {
                            'KeyToMatch': 'string',
                            'Script': 'string'
                        }
                    }
                }
            },
        ],
        'LicenseAssetRulesetArn': 'string'
    }
}

Response Structure

  • (dict) --

    • LicenseAssetRuleset (dict) --

      License asset ruleset.

      • Name (string) --

        License asset ruleset name.

      • Description (string) --

        License asset ruleset description.

      • Rules (list) --

        License asset rules.

        • (dict) --

          License asset rule.

          • RuleStatement (dict) --

            Rule statement.

            • LicenseConfigurationRuleStatement (dict) --

              License configuration rule statement.

              • AndRuleStatement (dict) --

                AND rule statement.

                • MatchingRuleStatements (list) --

                  Matching rule statements.

                  • (dict) --

                    Matching rule statement.

                    • KeyToMatch (string) --

                      Key to match.

                      The following keys and are supported when the RuleStatement type is Instance:

                      • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                      • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                      • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                      • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                      • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License:

                      • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                      • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License Configuration:

                      • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • Constraint (string) --

                      Constraint.

                    • ValueToMatch (list) --

                      Value to match.

                      • (string) --

                • ScriptRuleStatements (list) --

                  Script rule statements.

                  • (dict) --

                    Rule statement that uses a script to evaluate license asset conditions.

                    • KeyToMatch (string) --

                      Key name to match against in the script rule evaluation.

                    • Script (string) --

                      Script code used to evaluate the rule condition.

              • OrRuleStatement (dict) --

                OR rule statement.

                • MatchingRuleStatements (list) --

                  Matching rule statements.

                  • (dict) --

                    Matching rule statement.

                    • KeyToMatch (string) --

                      Key to match.

                      The following keys and are supported when the RuleStatement type is Instance:

                      • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                      • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                      • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                      • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                      • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License:

                      • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                      • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License Configuration:

                      • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • Constraint (string) --

                      Constraint.

                    • ValueToMatch (list) --

                      Value to match.

                      • (string) --

                • ScriptRuleStatements (list) --

                  Script rule statements.

                  • (dict) --

                    Rule statement that uses a script to evaluate license asset conditions.

                    • KeyToMatch (string) --

                      Key name to match against in the script rule evaluation.

                    • Script (string) --

                      Script code used to evaluate the rule condition.

              • MatchingRuleStatement (dict) --

                Matching rule statement.

                • KeyToMatch (string) --

                  Key to match.

                  The following keys and are supported when the RuleStatement type is Instance:

                  • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                  • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                  • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                  • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                  • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                  • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                  • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                  • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                  The following keys and are supported when the RuleStatement type is License:

                  • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                  • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                  The following keys and are supported when the RuleStatement type is License Configuration:

                  • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                  • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • Constraint (string) --

                  Constraint.

                • ValueToMatch (list) --

                  Value to match.

                  • (string) --

            • LicenseRuleStatement (dict) --

              License rule statement.

              • AndRuleStatement (dict) --

                AND rule statement.

                • MatchingRuleStatements (list) --

                  Matching rule statements.

                  • (dict) --

                    Matching rule statement.

                    • KeyToMatch (string) --

                      Key to match.

                      The following keys and are supported when the RuleStatement type is Instance:

                      • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                      • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                      • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                      • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                      • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License:

                      • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                      • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License Configuration:

                      • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • Constraint (string) --

                      Constraint.

                    • ValueToMatch (list) --

                      Value to match.

                      • (string) --

                • ScriptRuleStatements (list) --

                  Script rule statements.

                  • (dict) --

                    Rule statement that uses a script to evaluate license asset conditions.

                    • KeyToMatch (string) --

                      Key name to match against in the script rule evaluation.

                    • Script (string) --

                      Script code used to evaluate the rule condition.

              • OrRuleStatement (dict) --

                OR rule statement.

                • MatchingRuleStatements (list) --

                  Matching rule statements.

                  • (dict) --

                    Matching rule statement.

                    • KeyToMatch (string) --

                      Key to match.

                      The following keys and are supported when the RuleStatement type is Instance:

                      • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                      • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                      • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                      • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                      • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License:

                      • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                      • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License Configuration:

                      • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • Constraint (string) --

                      Constraint.

                    • ValueToMatch (list) --

                      Value to match.

                      • (string) --

                • ScriptRuleStatements (list) --

                  Script rule statements.

                  • (dict) --

                    Rule statement that uses a script to evaluate license asset conditions.

                    • KeyToMatch (string) --

                      Key name to match against in the script rule evaluation.

                    • Script (string) --

                      Script code used to evaluate the rule condition.

              • MatchingRuleStatement (dict) --

                Matching rule statement.

                • KeyToMatch (string) --

                  Key to match.

                  The following keys and are supported when the RuleStatement type is Instance:

                  • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                  • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                  • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                  • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                  • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                  • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                  • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                  • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                  The following keys and are supported when the RuleStatement type is License:

                  • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                  • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                  The following keys and are supported when the RuleStatement type is License Configuration:

                  • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                  • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • Constraint (string) --

                  Constraint.

                • ValueToMatch (list) --

                  Value to match.

                  • (string) --

            • InstanceRuleStatement (dict) --

              Instance rule statement.

              • AndRuleStatement (dict) --

                AND rule statement.

                • MatchingRuleStatements (list) --

                  Matching rule statements.

                  • (dict) --

                    Matching rule statement.

                    • KeyToMatch (string) --

                      Key to match.

                      The following keys and are supported when the RuleStatement type is Instance:

                      • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                      • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                      • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                      • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                      • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License:

                      • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                      • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License Configuration:

                      • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • Constraint (string) --

                      Constraint.

                    • ValueToMatch (list) --

                      Value to match.

                      • (string) --

                • ScriptRuleStatements (list) --

                  Script rule statements.

                  • (dict) --

                    Rule statement that uses a script to evaluate license asset conditions.

                    • KeyToMatch (string) --

                      Key name to match against in the script rule evaluation.

                    • Script (string) --

                      Script code used to evaluate the rule condition.

              • OrRuleStatement (dict) --

                OR rule statement.

                • MatchingRuleStatements (list) --

                  Matching rule statements.

                  • (dict) --

                    Matching rule statement.

                    • KeyToMatch (string) --

                      Key to match.

                      The following keys and are supported when the RuleStatement type is Instance:

                      • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                      • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                      • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                      • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                      • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                      • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License:

                      • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                      • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                      • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                      The following keys and are supported when the RuleStatement type is License Configuration:

                      • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                      • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                    • Constraint (string) --

                      Constraint.

                    • ValueToMatch (list) --

                      Value to match.

                      • (string) --

                • ScriptRuleStatements (list) --

                  Script rule statements.

                  • (dict) --

                    Rule statement that uses a script to evaluate license asset conditions.

                    • KeyToMatch (string) --

                      Key name to match against in the script rule evaluation.

                    • Script (string) --

                      Script code used to evaluate the rule condition.

              • MatchingRuleStatement (dict) --

                Matching rule statement.

                • KeyToMatch (string) --

                  Key to match.

                  The following keys and are supported when the RuleStatement type is Instance:

                  • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                  • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                  • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                  • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                  • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                  • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                  • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                  • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                  The following keys and are supported when the RuleStatement type is License:

                  • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                  • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                  • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                  The following keys and are supported when the RuleStatement type is License Configuration:

                  • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                  • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • Constraint (string) --

                  Constraint.

                • ValueToMatch (list) --

                  Value to match.

                  • (string) --

              • ScriptRuleStatement (dict) --

                Script rule statement.

                • KeyToMatch (string) --

                  Key name to match against in the script rule evaluation.

                • Script (string) --

                  Script code used to evaluate the rule condition.

      • LicenseAssetRulesetArn (string) --

        Amazon Resource Name (ARN) of the license asset ruleset.

UpdateLicenseAssetGroup (new) Link ¶

Updates a license asset group.

See also: AWS API Documentation

Request Syntax

client.update_license_asset_group(
    Name='string',
    Description='string',
    LicenseAssetGroupConfigurations=[
        {
            'UsageDimension': 'string'
        },
    ],
    AssociatedLicenseAssetRulesetARNs=[
        'string',
    ],
    Properties=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    LicenseAssetGroupArn='string',
    Status='ACTIVE'|'DISABLED'|'DELETED',
    ClientToken='string'
)
type Name:

string

param Name:

License asset group name.

type Description:

string

param Description:

License asset group description.

type LicenseAssetGroupConfigurations:

list

param LicenseAssetGroupConfigurations:

License asset group configurations.

  • (dict) --

    License asset group configuration.

    • UsageDimension (string) --

      License Asset Group Configuration Usage dimension.

type AssociatedLicenseAssetRulesetARNs:

list

param AssociatedLicenseAssetRulesetARNs:

[REQUIRED]

ARNs of associated license asset rulesets.

  • (string) --

type Properties:

list

param Properties:

License asset group properties.

  • (dict) --

    License asset group property.

    • Key (string) -- [REQUIRED]

      Property key.

    • Value (string) -- [REQUIRED]

      Property value.

type LicenseAssetGroupArn:

string

param LicenseAssetGroupArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license asset group.

type Status:

string

param Status:

License asset group status. The possible values are ACTIVE | DISABLED.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetGroupArn': 'string',
    'Status': 'string'
}

Response Structure

  • (dict) --

    • LicenseAssetGroupArn (string) --

      Amazon Resource Name (ARN) of the license asset group.

    • Status (string) --

      License asset group status.

DeleteLicenseAssetGroup (new) Link ¶

Deletes a license asset group.

See also: AWS API Documentation

Request Syntax

client.delete_license_asset_group(
    LicenseAssetGroupArn='string'
)
type LicenseAssetGroupArn:

string

param LicenseAssetGroupArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license asset group.

rtype:

dict

returns:

Response Syntax

{
    'Status': 'ACTIVE'|'DISABLED'|'DELETED'
}

Response Structure

  • (dict) --

    • Status (string) --

      License asset group status.

CreateLicenseAssetRuleset (new) Link ¶

Creates a license asset ruleset.

See also: AWS API Documentation

Request Syntax

client.create_license_asset_ruleset(
    Name='string',
    Description='string',
    Rules=[
        {
            'RuleStatement': {
                'LicenseConfigurationRuleStatement': {
                    'AndRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'OrRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'MatchingRuleStatement': {
                        'KeyToMatch': 'string',
                        'Constraint': 'string',
                        'ValueToMatch': [
                            'string',
                        ]
                    }
                },
                'LicenseRuleStatement': {
                    'AndRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'OrRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'MatchingRuleStatement': {
                        'KeyToMatch': 'string',
                        'Constraint': 'string',
                        'ValueToMatch': [
                            'string',
                        ]
                    }
                },
                'InstanceRuleStatement': {
                    'AndRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'OrRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'MatchingRuleStatement': {
                        'KeyToMatch': 'string',
                        'Constraint': 'string',
                        'ValueToMatch': [
                            'string',
                        ]
                    },
                    'ScriptRuleStatement': {
                        'KeyToMatch': 'string',
                        'Script': 'string'
                    }
                }
            }
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
type Name:

string

param Name:

[REQUIRED]

License asset ruleset name.

type Description:

string

param Description:

License asset ruleset description.

type Rules:

list

param Rules:

[REQUIRED]

License asset rules.

  • (dict) --

    License asset rule.

    • RuleStatement (dict) -- [REQUIRED]

      Rule statement.

      • LicenseConfigurationRuleStatement (dict) --

        License configuration rule statement.

        • AndRuleStatement (dict) --

          AND rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • OrRuleStatement (dict) --

          OR rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • MatchingRuleStatement (dict) --

          Matching rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key to match.

            The following keys and are supported when the RuleStatement type is Instance:

            • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

            • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

            • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

            • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

            • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License:

            • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

            • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

            • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

            • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License Configuration:

            • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

          • Constraint (string) -- [REQUIRED]

            Constraint.

          • ValueToMatch (list) -- [REQUIRED]

            Value to match.

            • (string) --

      • LicenseRuleStatement (dict) --

        License rule statement.

        • AndRuleStatement (dict) --

          AND rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • OrRuleStatement (dict) --

          OR rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • MatchingRuleStatement (dict) --

          Matching rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key to match.

            The following keys and are supported when the RuleStatement type is Instance:

            • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

            • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

            • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

            • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

            • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License:

            • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

            • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

            • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

            • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License Configuration:

            • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

          • Constraint (string) -- [REQUIRED]

            Constraint.

          • ValueToMatch (list) -- [REQUIRED]

            Value to match.

            • (string) --

      • InstanceRuleStatement (dict) --

        Instance rule statement.

        • AndRuleStatement (dict) --

          AND rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • OrRuleStatement (dict) --

          OR rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • MatchingRuleStatement (dict) --

          Matching rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key to match.

            The following keys and are supported when the RuleStatement type is Instance:

            • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

            • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

            • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

            • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

            • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License:

            • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

            • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

            • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

            • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License Configuration:

            • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

          • Constraint (string) -- [REQUIRED]

            Constraint.

          • ValueToMatch (list) -- [REQUIRED]

            Value to match.

            • (string) --

        • ScriptRuleStatement (dict) --

          Script rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key name to match against in the script rule evaluation.

          • Script (string) -- [REQUIRED]

            Script code used to evaluate the rule condition.

type Tags:

list

param Tags:

Tags to add to the license asset ruleset.

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

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetRulesetArn': 'string'
}

Response Structure

  • (dict) --

    • LicenseAssetRulesetArn (string) --

      Amazon Resource Name (ARN) of the license asset ruleset.

DeleteLicenseAssetRuleset (new) Link ¶

Deletes a license asset ruleset.

See also: AWS API Documentation

Request Syntax

client.delete_license_asset_ruleset(
    LicenseAssetRulesetArn='string'
)
type LicenseAssetRulesetArn:

string

param LicenseAssetRulesetArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license asset ruleset.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateLicenseAssetRuleset (new) Link ¶

Updates a license asset ruleset.

See also: AWS API Documentation

Request Syntax

client.update_license_asset_ruleset(
    Name='string',
    Description='string',
    Rules=[
        {
            'RuleStatement': {
                'LicenseConfigurationRuleStatement': {
                    'AndRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'OrRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'MatchingRuleStatement': {
                        'KeyToMatch': 'string',
                        'Constraint': 'string',
                        'ValueToMatch': [
                            'string',
                        ]
                    }
                },
                'LicenseRuleStatement': {
                    'AndRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'OrRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'MatchingRuleStatement': {
                        'KeyToMatch': 'string',
                        'Constraint': 'string',
                        'ValueToMatch': [
                            'string',
                        ]
                    }
                },
                'InstanceRuleStatement': {
                    'AndRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'OrRuleStatement': {
                        'MatchingRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Constraint': 'string',
                                'ValueToMatch': [
                                    'string',
                                ]
                            },
                        ],
                        'ScriptRuleStatements': [
                            {
                                'KeyToMatch': 'string',
                                'Script': 'string'
                            },
                        ]
                    },
                    'MatchingRuleStatement': {
                        'KeyToMatch': 'string',
                        'Constraint': 'string',
                        'ValueToMatch': [
                            'string',
                        ]
                    },
                    'ScriptRuleStatement': {
                        'KeyToMatch': 'string',
                        'Script': 'string'
                    }
                }
            }
        },
    ],
    LicenseAssetRulesetArn='string',
    ClientToken='string'
)
type Name:

string

param Name:

License asset ruleset name.

type Description:

string

param Description:

License asset ruleset description.

type Rules:

list

param Rules:

[REQUIRED]

License asset rules.

  • (dict) --

    License asset rule.

    • RuleStatement (dict) -- [REQUIRED]

      Rule statement.

      • LicenseConfigurationRuleStatement (dict) --

        License configuration rule statement.

        • AndRuleStatement (dict) --

          AND rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • OrRuleStatement (dict) --

          OR rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • MatchingRuleStatement (dict) --

          Matching rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key to match.

            The following keys and are supported when the RuleStatement type is Instance:

            • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

            • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

            • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

            • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

            • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License:

            • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

            • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

            • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

            • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License Configuration:

            • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

          • Constraint (string) -- [REQUIRED]

            Constraint.

          • ValueToMatch (list) -- [REQUIRED]

            Value to match.

            • (string) --

      • LicenseRuleStatement (dict) --

        License rule statement.

        • AndRuleStatement (dict) --

          AND rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • OrRuleStatement (dict) --

          OR rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • MatchingRuleStatement (dict) --

          Matching rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key to match.

            The following keys and are supported when the RuleStatement type is Instance:

            • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

            • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

            • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

            • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

            • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License:

            • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

            • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

            • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

            • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License Configuration:

            • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

          • Constraint (string) -- [REQUIRED]

            Constraint.

          • ValueToMatch (list) -- [REQUIRED]

            Value to match.

            • (string) --

      • InstanceRuleStatement (dict) --

        Instance rule statement.

        • AndRuleStatement (dict) --

          AND rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • OrRuleStatement (dict) --

          OR rule statement.

          • MatchingRuleStatements (list) --

            Matching rule statements.

            • (dict) --

              Matching rule statement.

              • KeyToMatch (string) -- [REQUIRED]

                Key to match.

                The following keys and are supported when the RuleStatement type is Instance:

                • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

                • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

                • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

                • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

                • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

                • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License:

                • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

                • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

                • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

                • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

                • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

                The following keys and are supported when the RuleStatement type is License Configuration:

                • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

                • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

              • Constraint (string) -- [REQUIRED]

                Constraint.

              • ValueToMatch (list) -- [REQUIRED]

                Value to match.

                • (string) --

          • ScriptRuleStatements (list) --

            Script rule statements.

            • (dict) --

              Rule statement that uses a script to evaluate license asset conditions.

              • KeyToMatch (string) -- [REQUIRED]

                Key name to match against in the script rule evaluation.

              • Script (string) -- [REQUIRED]

                Script code used to evaluate the rule condition.

        • MatchingRuleStatement (dict) --

          Matching rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key to match.

            The following keys and are supported when the RuleStatement type is Instance:

            • Platform - The name of the platform. Logical operators are EQUALS and NOT_EQUALS.

            • EC2BillingProduct - The billing product code. Logical operators are EQUALS and NOT_EQUALS. Possible values are: windows-server-enterprise | windows-byol | rhel | rhel-byol | rhel-high-availability | ubuntu-pro | suse-linux | sql-server-standard | sql-server-enterprise.

            • MarketPlaceProductCode - The Marketplace product code. Logical operators are EQUALS and NOT_EQUALS.

            • AMIId - The ID of the AMI. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceType - The instance type. Logical operators are EQUALS and NOT_EQUALS.

            • InstanceId - The ID of the instance. Logical operators are EQUALS and NOT_EQUALS.

            • HostId - The ID of the host. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The ID of the account. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License:

            • LicenseArn - The ARN of a Managed Entitlement License. Logical operators are EQUALS and NOT_EQUALS.

            • ProductSKU - The productSKU of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Issuer - The issuer of the license. Logical operators are EQUALS and NOT_EQUALS.

            • Beneficiary - The beneficiary of the license. Logical operators are EQUALS and NOT_EQUALS.

            • LicenseStatus - The status of the license. Logical operators are EQUALS and NOT_EQUALS.

            • HomeRegion - The home region of the license. Logical operators are EQUALS and NOT_EQUALS.

            The following keys and are supported when the RuleStatement type is License Configuration:

            • LicenseConfigurationArn - The ARN of a self-managed license configuration. Logical operators are EQUALS and NOT_EQUALS.

            • AccountId - The account of the license configuration. Logical operators are EQUALS and NOT_EQUALS.

          • Constraint (string) -- [REQUIRED]

            Constraint.

          • ValueToMatch (list) -- [REQUIRED]

            Value to match.

            • (string) --

        • ScriptRuleStatement (dict) --

          Script rule statement.

          • KeyToMatch (string) -- [REQUIRED]

            Key name to match against in the script rule evaluation.

          • Script (string) -- [REQUIRED]

            Script code used to evaluate the rule condition.

type LicenseAssetRulesetArn:

string

param LicenseAssetRulesetArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license asset ruleset.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetRulesetArn': 'string'
}

Response Structure

  • (dict) --

    • LicenseAssetRulesetArn (string) --

      Amazon Resource Name (ARN) of the license asset ruleset.

GetLicenseAssetGroup (new) Link ¶

Gets a license asset group.

See also: AWS API Documentation

Request Syntax

client.get_license_asset_group(
    LicenseAssetGroupArn='string'
)
type LicenseAssetGroupArn:

string

param LicenseAssetGroupArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license asset group.

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetGroup': {
        'Name': 'string',
        'Description': 'string',
        'LicenseAssetGroupConfigurations': [
            {
                'UsageDimension': 'string'
            },
        ],
        'AssociatedLicenseAssetRulesetARNs': [
            'string',
        ],
        'Properties': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LicenseAssetGroupArn': 'string',
        'Status': 'ACTIVE'|'DISABLED'|'DELETED',
        'StatusMessage': 'string',
        'LatestUsageAnalysisTime': datetime(2015, 1, 1),
        'LatestResourceDiscoveryTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • LicenseAssetGroup (dict) --

      License asset group.

      • Name (string) --

        License asset group name.

      • Description (string) --

        License asset group description.

      • LicenseAssetGroupConfigurations (list) --

        License asset group configurations.

        • (dict) --

          License asset group configuration.

          • UsageDimension (string) --

            License Asset Group Configuration Usage dimension.

      • AssociatedLicenseAssetRulesetARNs (list) --

        ARNs of associated license asset rulesets.

        • (string) --

      • Properties (list) --

        License asset group properties.

        • (dict) --

          License asset group property.

          • Key (string) --

            Property key.

          • Value (string) --

            Property value.

      • LicenseAssetGroupArn (string) --

        Amazon Resource Name (ARN) of the license asset group.

      • Status (string) --

        License asset group status.

      • StatusMessage (string) --

        License asset group status message.

      • LatestUsageAnalysisTime (datetime) --

        Latest usage analysis time.

      • LatestResourceDiscoveryTime (datetime) --

        Latest resource discovery time.

ListLicenseConfigurationsForOrganization (new) Link ¶

Lists license configurations for an organization.

See also: AWS API Documentation

Request Syntax

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

list

param LicenseConfigurationArns:

License configuration ARNs.

  • (string) --

type MaxResults:

integer

param MaxResults:

Maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

Token for the next set of results.

type Filters:

list

param Filters:

Filters to scope the results.

  • (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) --

rtype:

dict

returns:

Response Syntax

{
    'LicenseConfigurations': [
        {
            'LicenseConfigurationId': 'string',
            'LicenseConfigurationArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'LicenseCountingType': 'vCPU'|'Instance'|'Core'|'Socket',
            'LicenseRules': [
                'string',
            ],
            'LicenseCount': 123,
            'LicenseCountHardLimit': True|False,
            'DisassociateWhenNotFound': True|False,
            'ConsumedLicenses': 123,
            'Status': 'string',
            'OwnerAccountId': 'string',
            'ConsumedLicenseSummaryList': [
                {
                    'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
                    'ConsumedLicenses': 123
                },
            ],
            'ManagedResourceSummaryList': [
                {
                    'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
                    'AssociationCount': 123
                },
            ],
            'ProductInformationList': [
                {
                    'ResourceType': 'string',
                    'ProductInformationFilterList': [
                        {
                            'ProductInformationFilterName': 'string',
                            'ProductInformationFilterValue': [
                                'string',
                            ],
                            'ProductInformationFilterComparator': 'string'
                        },
                    ]
                },
            ],
            'AutomatedDiscoveryInformation': {
                'LastRunTime': datetime(2015, 1, 1)
            },
            'LicenseExpiry': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseConfigurations (list) --

      License configurations.

      • (dict) --

        A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.

        • LicenseConfigurationId (string) --

          Unique ID of the license configuration.

        • LicenseConfigurationArn (string) --

          Amazon Resource Name (ARN) of the license configuration.

        • Name (string) --

          Name of the license configuration.

        • Description (string) --

          Description of the license configuration.

        • LicenseCountingType (string) --

          Dimension to use to track the license inventory.

        • LicenseRules (list) --

          License rules.

          • (string) --

        • LicenseCount (integer) --

          Number of licenses managed by the license configuration.

        • LicenseCountHardLimit (boolean) --

          Number of available licenses as a hard limit.

        • DisassociateWhenNotFound (boolean) --

          When true, disassociates a resource when software is uninstalled.

        • ConsumedLicenses (integer) --

          Number of licenses consumed.

        • Status (string) --

          Status of the license configuration.

        • OwnerAccountId (string) --

          Account ID of the license configuration's owner.

        • ConsumedLicenseSummaryList (list) --

          Summaries for licenses consumed by various resources.

          • (dict) --

            Details about license consumption.

            • ResourceType (string) --

              Resource type of the resource consuming a license.

            • ConsumedLicenses (integer) --

              Number of licenses consumed by the resource.

        • ManagedResourceSummaryList (list) --

          Summaries for managed resources.

          • (dict) --

            Summary information about a managed resource.

            • ResourceType (string) --

              Type of resource associated with a license.

            • AssociationCount (integer) --

              Number of resources associated with licenses.

        • ProductInformationList (list) --

          Product information.

          • (dict) --

            Describes product information for a license configuration.

            • ResourceType (string) --

              Resource type. The possible values are SSM_MANAGED | RDS.

            • ProductInformationFilterList (list) --

              A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

              Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

              The following filters and are supported when the resource type is SSM_MANAGED:

              • Application Name - The name of the application. Logical operator is EQUALS.

              • Application Publisher - The publisher of the application. Logical operator is EQUALS.

              • Application Version - The version of the application. Logical operator is EQUALS.

              • Platform Name - The name of the platform. Logical operator is EQUALS.

              • Platform Type - The platform type. Logical operator is EQUALS.

              • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

              • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

              • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

              The following filters and logical operators are supported when the resource type is RDS:

              • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 | db2-se | db2-ae.

              • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

              • (dict) --

                Describes product information filters.

                • ProductInformationFilterName (string) --

                  Filter name.

                • ProductInformationFilterValue (list) --

                  Filter value.

                  • (string) --

                • ProductInformationFilterComparator (string) --

                  Logical operator.

        • AutomatedDiscoveryInformation (dict) --

          Automated discovery information.

          • LastRunTime (datetime) --

            Time that automated discovery last ran.

        • LicenseExpiry (integer) --

          License configuration expiry time in Unix timestamp format.

    • NextToken (string) --

      Token for the next set of results.

ListLicenseAssetGroups (new) Link ¶

Lists license asset groups.

See also: AWS API Documentation

Request Syntax

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

list

param Filters:

Filters to scope the results. Following filters are supported

  • LicenseAssetRulesetArn

  • (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) --

type MaxResults:

integer

param MaxResults:

Maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

Token for the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'LicenseAssetGroups': [
        {
            'Name': 'string',
            'Description': 'string',
            'LicenseAssetGroupConfigurations': [
                {
                    'UsageDimension': 'string'
                },
            ],
            'AssociatedLicenseAssetRulesetARNs': [
                'string',
            ],
            'Properties': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'LicenseAssetGroupArn': 'string',
            'Status': 'ACTIVE'|'DISABLED'|'DELETED',
            'StatusMessage': 'string',
            'LatestUsageAnalysisTime': datetime(2015, 1, 1),
            'LatestResourceDiscoveryTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseAssetGroups (list) --

      License asset groups.

      • (dict) --

        License asset group.

        • Name (string) --

          License asset group name.

        • Description (string) --

          License asset group description.

        • LicenseAssetGroupConfigurations (list) --

          License asset group configurations.

          • (dict) --

            License asset group configuration.

            • UsageDimension (string) --

              License Asset Group Configuration Usage dimension.

        • AssociatedLicenseAssetRulesetARNs (list) --

          ARNs of associated license asset rulesets.

          • (string) --

        • Properties (list) --

          License asset group properties.

          • (dict) --

            License asset group property.

            • Key (string) --

              Property key.

            • Value (string) --

              Property value.

        • LicenseAssetGroupArn (string) --

          Amazon Resource Name (ARN) of the license asset group.

        • Status (string) --

          License asset group status.

        • StatusMessage (string) --

          License asset group status message.

        • LatestUsageAnalysisTime (datetime) --

          Latest usage analysis time.

        • LatestResourceDiscoveryTime (datetime) --

          Latest resource discovery time.

    • NextToken (string) --

      Token for the next set of results.

CreateLicenseConfiguration (updated) Link ¶
Changes (request)
{'LicenseExpiry': 'long'}

Creates a license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.

See also: AWS API Documentation

Request Syntax

client.create_license_configuration(
    Name='string',
    Description='string',
    LicenseCountingType='vCPU'|'Instance'|'Core'|'Socket',
    LicenseCount=123,
    LicenseCountHardLimit=True|False,
    LicenseRules=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DisassociateWhenNotFound=True|False,
    ProductInformationList=[
        {
            'ResourceType': 'string',
            'ProductInformationFilterList': [
                {
                    'ProductInformationFilterName': 'string',
                    'ProductInformationFilterValue': [
                        'string',
                    ],
                    'ProductInformationFilterComparator': 'string'
                },
            ]
        },
    ],
    LicenseExpiry=123
)
type Name:

string

param Name:

[REQUIRED]

Name of the license configuration.

type Description:

string

param Description:

Description of the license configuration.

type LicenseCountingType:

string

param LicenseCountingType:

[REQUIRED]

Dimension used to track the license inventory.

type LicenseCount:

integer

param LicenseCount:

Number of licenses managed by the license configuration.

type LicenseCountHardLimit:

boolean

param LicenseCountHardLimit:

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

type LicenseRules:

list

param LicenseRules:

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

  • Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

  • Instances dimension: allowedTenancy | maximumVcpus | minimumVcpus

  • Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

  • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

  • (string) --

type Tags:

list

param Tags:

Tags to add to the license configuration.

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

type DisassociateWhenNotFound:

boolean

param DisassociateWhenNotFound:

When true, disassociates a resource when software is uninstalled.

type ProductInformationList:

list

param ProductInformationList:

Product information.

  • (dict) --

    Describes product information for a license configuration.

    • ResourceType (string) -- [REQUIRED]

      Resource type. The possible values are SSM_MANAGED | RDS.

    • ProductInformationFilterList (list) -- [REQUIRED]

      A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

      Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

      The following filters and are supported when the resource type is SSM_MANAGED:

      • Application Name - The name of the application. Logical operator is EQUALS.

      • Application Publisher - The publisher of the application. Logical operator is EQUALS.

      • Application Version - The version of the application. Logical operator is EQUALS.

      • Platform Name - The name of the platform. Logical operator is EQUALS.

      • Platform Type - The platform type. Logical operator is EQUALS.

      • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

      • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

      • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

      The following filters and logical operators are supported when the resource type is RDS:

      • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 | db2-se | db2-ae.

      • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

      • (dict) --

        Describes product information filters.

        • ProductInformationFilterName (string) -- [REQUIRED]

          Filter name.

        • ProductInformationFilterValue (list) --

          Filter value.

          • (string) --

        • ProductInformationFilterComparator (string) -- [REQUIRED]

          Logical operator.

type LicenseExpiry:

integer

param LicenseExpiry:

License configuration expiry.

rtype:

dict

returns:

Response Syntax

{
    'LicenseConfigurationArn': 'string'
}

Response Structure

  • (dict) --

    • LicenseConfigurationArn (string) --

      Amazon Resource Name (ARN) of the license configuration.

CreateLicenseManagerReportGenerator (updated) Link ¶
Changes (request)
{'ReportContext': {'licenseAssetGroupArns': ['string'],
                   'reportEndDate': 'timestamp',
                   'reportStartDate': 'timestamp'},
 'ReportFrequency': {'period': {'ONE_TIME'}},
 'Type': {'LicenseAssetGroupUsageReport'}}

Creates a report generator.

See also: AWS API Documentation

Request Syntax

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

GetLicenseConfiguration (updated) Link ¶
Changes (response)
{'LicenseExpiry': 'long'}

Gets detailed information about the specified license configuration.

See also: AWS API Documentation

Request Syntax

client.get_license_configuration(
    LicenseConfigurationArn='string'
)
type LicenseConfigurationArn:

string

param LicenseConfigurationArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.

rtype:

dict

returns:

Response Syntax

{
    'LicenseConfigurationId': 'string',
    'LicenseConfigurationArn': 'string',
    'Name': 'string',
    'Description': 'string',
    'LicenseCountingType': 'vCPU'|'Instance'|'Core'|'Socket',
    'LicenseRules': [
        'string',
    ],
    'LicenseCount': 123,
    'LicenseCountHardLimit': True|False,
    'ConsumedLicenses': 123,
    'Status': 'string',
    'OwnerAccountId': 'string',
    'ConsumedLicenseSummaryList': [
        {
            'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
            'ConsumedLicenses': 123
        },
    ],
    'ManagedResourceSummaryList': [
        {
            'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
            'AssociationCount': 123
        },
    ],
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'ProductInformationList': [
        {
            'ResourceType': 'string',
            'ProductInformationFilterList': [
                {
                    'ProductInformationFilterName': 'string',
                    'ProductInformationFilterValue': [
                        'string',
                    ],
                    'ProductInformationFilterComparator': 'string'
                },
            ]
        },
    ],
    'AutomatedDiscoveryInformation': {
        'LastRunTime': datetime(2015, 1, 1)
    },
    'DisassociateWhenNotFound': True|False,
    'LicenseExpiry': 123
}

Response Structure

  • (dict) --

    • LicenseConfigurationId (string) --

      Unique ID for the license configuration.

    • LicenseConfigurationArn (string) --

      Amazon Resource Name (ARN) of the license configuration.

    • Name (string) --

      Name of the license configuration.

    • Description (string) --

      Description of the license configuration.

    • LicenseCountingType (string) --

      Dimension for which the licenses are counted.

    • LicenseRules (list) --

      License rules.

      • (string) --

    • LicenseCount (integer) --

      Number of available licenses.

    • LicenseCountHardLimit (boolean) --

      Sets the number of available licenses as a hard limit.

    • ConsumedLicenses (integer) --

      Number of licenses assigned to resources.

    • Status (string) --

      License configuration status.

    • OwnerAccountId (string) --

      Account ID of the owner of the license configuration.

    • ConsumedLicenseSummaryList (list) --

      Summaries of the licenses consumed by resources.

      • (dict) --

        Details about license consumption.

        • ResourceType (string) --

          Resource type of the resource consuming a license.

        • ConsumedLicenses (integer) --

          Number of licenses consumed by the resource.

    • ManagedResourceSummaryList (list) --

      Summaries of the managed resources.

      • (dict) --

        Summary information about a managed resource.

        • ResourceType (string) --

          Type of resource associated with a license.

        • AssociationCount (integer) --

          Number of resources associated with licenses.

    • Tags (list) --

      Tags for the license configuration.

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

    • ProductInformationList (list) --

      Product information.

      • (dict) --

        Describes product information for a license configuration.

        • ResourceType (string) --

          Resource type. The possible values are SSM_MANAGED | RDS.

        • ProductInformationFilterList (list) --

          A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

          Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

          The following filters and are supported when the resource type is SSM_MANAGED:

          • Application Name - The name of the application. Logical operator is EQUALS.

          • Application Publisher - The publisher of the application. Logical operator is EQUALS.

          • Application Version - The version of the application. Logical operator is EQUALS.

          • Platform Name - The name of the platform. Logical operator is EQUALS.

          • Platform Type - The platform type. Logical operator is EQUALS.

          • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

          • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

          • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

          The following filters and logical operators are supported when the resource type is RDS:

          • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 | db2-se | db2-ae.

          • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

          • (dict) --

            Describes product information filters.

            • ProductInformationFilterName (string) --

              Filter name.

            • ProductInformationFilterValue (list) --

              Filter value.

              • (string) --

            • ProductInformationFilterComparator (string) --

              Logical operator.

    • AutomatedDiscoveryInformation (dict) --

      Automated discovery information.

      • LastRunTime (datetime) --

        Time that automated discovery last ran.

    • DisassociateWhenNotFound (boolean) --

      When true, disassociates a resource when software is uninstalled.

    • LicenseExpiry (integer) --

      License Expiry.

GetLicenseManagerReportGenerator (updated) Link ¶
Changes (response)
{'ReportGenerator': {'ReportContext': {'licenseAssetGroupArns': ['string'],
                                       'reportEndDate': 'timestamp',
                                       'reportStartDate': 'timestamp'},
                     'ReportFrequency': {'period': {'ONE_TIME'}},
                     'ReportType': {'LicenseAssetGroupUsageReport'}}}

Gets information about 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]

Amazon Resource Name (ARN) of the report generator.

rtype:

dict

returns:

Response Syntax

{
    'ReportGenerator': {
        'ReportGeneratorName': 'string',
        'ReportType': [
            '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'
        },
        '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) --

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

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

GetServiceSettings (updated) Link ¶
Changes (response)
{'CrossRegionDiscoveryHomeRegion': 'string',
 'CrossRegionDiscoverySourceRegions': ['string'],
 'ServiceStatus': {'CrossAccountDiscovery': {'Message': 'string'},
                   'CrossRegionDiscovery': {'Message': {'string': {'Status': 'string'}}}}}

Gets the License Manager settings for the current Region.

See also: AWS API Documentation

Request Syntax

client.get_service_settings()
rtype:

dict

returns:

Response Syntax

{
    'S3BucketArn': 'string',
    'SnsTopicArn': 'string',
    'OrganizationConfiguration': {
        'EnableIntegration': True|False
    },
    'EnableCrossAccountsDiscovery': True|False,
    'LicenseManagerResourceShareArn': 'string',
    'CrossRegionDiscoveryHomeRegion': 'string',
    'CrossRegionDiscoverySourceRegions': [
        'string',
    ],
    'ServiceStatus': {
        'CrossAccountDiscovery': {
            'Message': 'string'
        },
        'CrossRegionDiscovery': {
            'Message': {
                'string': {
                    'Status': 'string'
                }
            }
        }
    }
}

Response Structure

  • (dict) --

    • S3BucketArn (string) --

      Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.

    • SnsTopicArn (string) --

      SNS topic configured to receive notifications from License Manager.

    • OrganizationConfiguration (dict) --

      Indicates whether Organizations is integrated with License Manager for cross-account discovery.

      • EnableIntegration (boolean) --

        Enables Organizations integration.

    • EnableCrossAccountsDiscovery (boolean) --

      Indicates whether cross-account discovery is enabled.

    • LicenseManagerResourceShareArn (string) --

      Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.

    • CrossRegionDiscoveryHomeRegion (string) --

      Cross region discovery home region.

    • CrossRegionDiscoverySourceRegions (list) --

      Cross region discovery source regions.

      • (string) --

    • ServiceStatus (dict) --

      Service status.

      • CrossAccountDiscovery (dict) --

        Status of cross-account discovery service.

        • Message (string) --

          Status message for cross-account discovery service.

      • CrossRegionDiscovery (dict) --

        Status of cross-region discovery service.

        • Message (dict) --

          Map of region status messages for cross-region discovery.

          • (string) --

            • (dict) --

              Status information for a specific region.

              • Status (string) --

                Status value for the region.

ListLicenseConfigurations (updated) Link ¶
Changes (response)
{'LicenseConfigurations': {'LicenseExpiry': 'long'}}

Lists the license configurations for your account.

See also: AWS API Documentation

Request Syntax

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

list

param LicenseConfigurationArns:

Amazon Resource Names (ARN) of the license configurations.

  • (string) --

type MaxResults:

integer

param MaxResults:

Maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

Token for the next set of results.

type Filters:

list

param Filters:

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

  • licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket.

  • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used.

  • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded.

  • (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) --

rtype:

dict

returns:

Response Syntax

{
    'LicenseConfigurations': [
        {
            'LicenseConfigurationId': 'string',
            'LicenseConfigurationArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'LicenseCountingType': 'vCPU'|'Instance'|'Core'|'Socket',
            'LicenseRules': [
                'string',
            ],
            'LicenseCount': 123,
            'LicenseCountHardLimit': True|False,
            'DisassociateWhenNotFound': True|False,
            'ConsumedLicenses': 123,
            'Status': 'string',
            'OwnerAccountId': 'string',
            'ConsumedLicenseSummaryList': [
                {
                    'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
                    'ConsumedLicenses': 123
                },
            ],
            'ManagedResourceSummaryList': [
                {
                    'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
                    'AssociationCount': 123
                },
            ],
            'ProductInformationList': [
                {
                    'ResourceType': 'string',
                    'ProductInformationFilterList': [
                        {
                            'ProductInformationFilterName': 'string',
                            'ProductInformationFilterValue': [
                                'string',
                            ],
                            'ProductInformationFilterComparator': 'string'
                        },
                    ]
                },
            ],
            'AutomatedDiscoveryInformation': {
                'LastRunTime': datetime(2015, 1, 1)
            },
            'LicenseExpiry': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseConfigurations (list) --

      Information about the license configurations.

      • (dict) --

        A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.

        • LicenseConfigurationId (string) --

          Unique ID of the license configuration.

        • LicenseConfigurationArn (string) --

          Amazon Resource Name (ARN) of the license configuration.

        • Name (string) --

          Name of the license configuration.

        • Description (string) --

          Description of the license configuration.

        • LicenseCountingType (string) --

          Dimension to use to track the license inventory.

        • LicenseRules (list) --

          License rules.

          • (string) --

        • LicenseCount (integer) --

          Number of licenses managed by the license configuration.

        • LicenseCountHardLimit (boolean) --

          Number of available licenses as a hard limit.

        • DisassociateWhenNotFound (boolean) --

          When true, disassociates a resource when software is uninstalled.

        • ConsumedLicenses (integer) --

          Number of licenses consumed.

        • Status (string) --

          Status of the license configuration.

        • OwnerAccountId (string) --

          Account ID of the license configuration's owner.

        • ConsumedLicenseSummaryList (list) --

          Summaries for licenses consumed by various resources.

          • (dict) --

            Details about license consumption.

            • ResourceType (string) --

              Resource type of the resource consuming a license.

            • ConsumedLicenses (integer) --

              Number of licenses consumed by the resource.

        • ManagedResourceSummaryList (list) --

          Summaries for managed resources.

          • (dict) --

            Summary information about a managed resource.

            • ResourceType (string) --

              Type of resource associated with a license.

            • AssociationCount (integer) --

              Number of resources associated with licenses.

        • ProductInformationList (list) --

          Product information.

          • (dict) --

            Describes product information for a license configuration.

            • ResourceType (string) --

              Resource type. The possible values are SSM_MANAGED | RDS.

            • ProductInformationFilterList (list) --

              A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

              Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

              The following filters and are supported when the resource type is SSM_MANAGED:

              • Application Name - The name of the application. Logical operator is EQUALS.

              • Application Publisher - The publisher of the application. Logical operator is EQUALS.

              • Application Version - The version of the application. Logical operator is EQUALS.

              • Platform Name - The name of the platform. Logical operator is EQUALS.

              • Platform Type - The platform type. Logical operator is EQUALS.

              • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

              • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

              • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

              The following filters and logical operators are supported when the resource type is RDS:

              • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 | db2-se | db2-ae.

              • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

              • (dict) --

                Describes product information filters.

                • ProductInformationFilterName (string) --

                  Filter name.

                • ProductInformationFilterValue (list) --

                  Filter value.

                  • (string) --

                • ProductInformationFilterComparator (string) --

                  Logical operator.

        • AutomatedDiscoveryInformation (dict) --

          Automated discovery information.

          • LastRunTime (datetime) --

            Time that automated discovery last ran.

        • LicenseExpiry (integer) --

          License configuration expiry time in Unix timestamp format.

    • NextToken (string) --

      Token for the next set of results.

ListLicenseManagerReportGenerators (updated) Link ¶
Changes (response)
{'ReportGenerators': {'ReportContext': {'licenseAssetGroupArns': ['string'],
                                        'reportEndDate': 'timestamp',
                                        'reportStartDate': 'timestamp'},
                      'ReportFrequency': {'period': {'ONE_TIME'}},
                      'ReportType': {'LicenseAssetGroupUsageReport'}}}

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) --

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

      • (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'|'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'
            },
            '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) --

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

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

    • NextToken (string) --

      Token for the next set of results.

ListResourceInventory (updated) Link ¶
Changes (response)
{'ResourceInventoryList': {'AmiId': 'string',
                           'HostId': 'string',
                           'InstanceType': 'string',
                           'MarketplaceProductCodes': ['string'],
                           'Region': 'string',
                           'UsageOperation': 'string'}}

Lists resources managed using Systems Manager inventory.

See also: AWS API Documentation

Request Syntax

client.list_resource_inventory(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Condition': 'EQUALS'|'NOT_EQUALS'|'BEGINS_WITH'|'CONTAINS',
            'Value': 'string'
        },
    ]
)
type MaxResults:

integer

param MaxResults:

Maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

Token for the next set of results.

type Filters:

list

param Filters:

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

  • account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

  • application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.

  • license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

  • platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.

  • resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).

  • (dict) --

    An inventory filter.

    • Name (string) -- [REQUIRED]

      Name of the filter.

    • Condition (string) -- [REQUIRED]

      Condition of the filter.

    • Value (string) --

      Value of the filter.

rtype:

dict

returns:

Response Syntax

{
    'ResourceInventoryList': [
        {
            'ResourceId': 'string',
            'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
            'ResourceArn': 'string',
            'Platform': 'string',
            'PlatformVersion': 'string',
            'ResourceOwningAccountId': 'string',
            'MarketplaceProductCodes': [
                'string',
            ],
            'UsageOperation': 'string',
            'AmiId': 'string',
            'HostId': 'string',
            'Region': 'string',
            'InstanceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ResourceInventoryList (list) --

      Information about the resources.

      • (dict) --

        Details about a resource.

        • ResourceId (string) --

          ID of the resource.

        • ResourceType (string) --

          Type of resource.

        • ResourceArn (string) --

          Amazon Resource Name (ARN) of the resource.

        • Platform (string) --

          Platform of the resource.

        • PlatformVersion (string) --

          Platform version of the resource in the inventory.

        • ResourceOwningAccountId (string) --

          ID of the account that owns the resource.

        • MarketplaceProductCodes (list) --

          List of Marketplace product codes associated with the resource.

          • (string) --

        • UsageOperation (string) --

          Usage operation value that corresponds to the license type for billing purposes.

        • AmiId (string) --

          Amazon Machine Image (AMI) ID associated with the resource.

        • HostId (string) --

          Dedicated Host ID where the resource is running.

        • Region (string) --

          Region where the resource is located.

        • InstanceType (string) --

          EC2 instance type of the resource.

    • NextToken (string) --

      Token for the next set of results.

UpdateLicenseConfiguration (updated) Link ¶
Changes (request)
{'LicenseExpiry': 'long'}

Modifies the attributes of an existing license configuration.

See also: AWS API Documentation

Request Syntax

client.update_license_configuration(
    LicenseConfigurationArn='string',
    LicenseConfigurationStatus='AVAILABLE'|'DISABLED',
    LicenseRules=[
        'string',
    ],
    LicenseCount=123,
    LicenseCountHardLimit=True|False,
    Name='string',
    Description='string',
    ProductInformationList=[
        {
            'ResourceType': 'string',
            'ProductInformationFilterList': [
                {
                    'ProductInformationFilterName': 'string',
                    'ProductInformationFilterValue': [
                        'string',
                    ],
                    'ProductInformationFilterComparator': 'string'
                },
            ]
        },
    ],
    DisassociateWhenNotFound=True|False,
    LicenseExpiry=123
)
type LicenseConfigurationArn:

string

param LicenseConfigurationArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.

type LicenseConfigurationStatus:

string

param LicenseConfigurationStatus:

New status of the license configuration.

type LicenseRules:

list

param LicenseRules:

New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

  • (string) --

type LicenseCount:

integer

param LicenseCount:

New number of licenses managed by the license configuration.

type LicenseCountHardLimit:

boolean

param LicenseCountHardLimit:

New hard limit of the number of available licenses.

type Name:

string

param Name:

New name of the license configuration.

type Description:

string

param Description:

New description of the license configuration.

type ProductInformationList:

list

param ProductInformationList:

New product information.

  • (dict) --

    Describes product information for a license configuration.

    • ResourceType (string) -- [REQUIRED]

      Resource type. The possible values are SSM_MANAGED | RDS.

    • ProductInformationFilterList (list) -- [REQUIRED]

      A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

      Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

      The following filters and are supported when the resource type is SSM_MANAGED:

      • Application Name - The name of the application. Logical operator is EQUALS.

      • Application Publisher - The publisher of the application. Logical operator is EQUALS.

      • Application Version - The version of the application. Logical operator is EQUALS.

      • Platform Name - The name of the platform. Logical operator is EQUALS.

      • Platform Type - The platform type. Logical operator is EQUALS.

      • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

      • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

      • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

      The following filters and logical operators are supported when the resource type is RDS:

      • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 | db2-se | db2-ae.

      • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

      • (dict) --

        Describes product information filters.

        • ProductInformationFilterName (string) -- [REQUIRED]

          Filter name.

        • ProductInformationFilterValue (list) --

          Filter value.

          • (string) --

        • ProductInformationFilterComparator (string) -- [REQUIRED]

          Logical operator.

type DisassociateWhenNotFound:

boolean

param DisassociateWhenNotFound:

When true, disassociates a resource when software is uninstalled.

type LicenseExpiry:

integer

param LicenseExpiry:

License configuration expiry time.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateLicenseManagerReportGenerator (updated) Link ¶
Changes (request)
{'ReportContext': {'licenseAssetGroupArns': ['string'],
                   'reportEndDate': 'timestamp',
                   'reportStartDate': 'timestamp'},
 'ReportFrequency': {'period': {'ONE_TIME'}},
 'Type': {'LicenseAssetGroupUsageReport'}}

Updates a report generator.

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

See also: AWS API Documentation

Request Syntax

client.update_license_manager_report_generator(
    LicenseManagerReportGeneratorArn='string',
    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'
)
type LicenseManagerReportGeneratorArn:

string

param LicenseManagerReportGeneratorArn:

[REQUIRED]

Amazon Resource Name (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 are supported:

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

The report context.

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

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateServiceSettings (updated) Link ¶
Changes (request)
{'EnabledDiscoverySourceRegions': ['string']}

Updates License Manager settings for the current Region.

See also: AWS API Documentation

Request Syntax

client.update_service_settings(
    S3BucketArn='string',
    SnsTopicArn='string',
    OrganizationConfiguration={
        'EnableIntegration': True|False
    },
    EnableCrossAccountsDiscovery=True|False,
    EnabledDiscoverySourceRegions=[
        'string',
    ]
)
type S3BucketArn:

string

param S3BucketArn:

Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.

type SnsTopicArn:

string

param SnsTopicArn:

Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

type OrganizationConfiguration:

dict

param OrganizationConfiguration:

Enables integration with Organizations for cross-account discovery.

  • EnableIntegration (boolean) -- [REQUIRED]

    Enables Organizations integration.

type EnableCrossAccountsDiscovery:

boolean

param EnableCrossAccountsDiscovery:

Activates cross-account discovery.

type EnabledDiscoverySourceRegions:

list

param EnabledDiscoverySourceRegions:

Cross region discovery enabled source regions.

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --