LicenseManager / Client / get_license_configuration

get_license_configuration

LicenseManager.Client.get_license_configuration(**kwargs)

Gets detailed information about the specified license configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_license_configuration(
    LicenseConfigurationArn='string'
)

Parameters:

LicenseConfigurationArn (string) –

[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.

Return type:

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
}

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 a tag for a license configuration.

      • Key (string) –

        Tag key.

      • Value (string) –

        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.

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

Exceptions

• LicenseManager.Client.exceptions.InvalidParameterValueException

• LicenseManager.Client.exceptions.ServerInternalException

• LicenseManager.Client.exceptions.AuthorizationException

• LicenseManager.Client.exceptions.AccessDeniedException

• LicenseManager.Client.exceptions.RateLimitExceededException