AWS License Manager

2019/12/02 - AWS License Manager - 1 new 8 updated api methods

Changes  AWS License Manager now automates discovery of bring-your-own-license usage across the customers organization. With few simple settings, customers can add bring your own license product information along with licensing rules, which would enable License Manager to automatically track the instances that have the specified products installed. If License Manager detects any violation of licensing rules, it would notify the customers designated license administrator to take corrective action.

ListFailuresForLicenseConfigurationOperations (new) Link ¶

Lists the license configuration operations that failed.

See also: AWS API Documentation

Request Syntax

client.list_failures_for_license_configuration_operations(
    LicenseConfigurationArn='string',
    MaxResults=123,
    NextToken='string'
)
type LicenseConfigurationArn

string

param LicenseConfigurationArn

[REQUIRED]

Amazon Resource Name of the license configuration.

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

{
    'LicenseOperationFailureList': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
            'ErrorMessage': 'string',
            'FailureTime': datetime(2015, 1, 1),
            'OperationName': 'string',
            'ResourceOwnerId': 'string',
            'OperationRequestedBy': 'string',
            'MetadataList': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseOperationFailureList (list) --

      License configuration operations that failed.

      • (dict) --

        Describes the failure of a license operation.

        • ResourceArn (string) --

          Amazon Resource Name (ARN) of the resource.

        • ResourceType (string) --

          Resource type.

        • ErrorMessage (string) --

          Error message.

        • FailureTime (datetime) --

          Failure time.

        • OperationName (string) --

          Name of the operation.

        • ResourceOwnerId (string) --

          ID of the AWS account that owns the resource.

        • OperationRequestedBy (string) --

          The requester is "License Manager Automated Discovery".

        • MetadataList (list) --

          Reserved.

          • (dict) --

            Reserved.

            • Name (string) --

              Reserved.

            • Value (string) --

              Reserved.

    • NextToken (string) --

      Token for the next set of results.

CreateLicenseConfiguration (updated) Link ¶
Changes (request)
{'ProductInformationList': [{'ProductInformationFilterList': [{'ProductInformationFilterComparator': 'string',
                                                               'ProductInformationFilterName': 'string',
                                                               'ProductInformationFilterValue': ['string']}],
                             'ResourceType': 'string'}]}

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), host affinity (how long a VM 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'
        },
    ],
    ProductInformationList=[
        {
            'ResourceType': 'string',
            'ProductInformationFilterList': [
                {
                    'ProductInformationFilterName': 'string',
                    'ProductInformationFilterValue': [
                        'string',
                    ],
                    'ProductInformationFilterComparator': 'string'
                },
            ]
        },
    ]
)
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). Available rules vary by dimension.

  • Cores dimension: allowedTenancy | maximumCores | minimumCores

  • Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus

  • Sockets dimension: allowedTenancy | maximumSockets | minimumSockets

  • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

  • (string) --

type Tags

list

param Tags

Tags to add to the license configuration.

  • (dict) --

    Details about a tag for a license configuration.

    • Key (string) --

      Tag key.

    • Value (string) --

      Tag value.

type ProductInformationList

list

param ProductInformationList

Product information.

  • (dict) --

    Describes product information for a license configuration.

    • ResourceType (string) -- [REQUIRED]

      Resource type. The value is SSM_MANAGED .

    • ProductInformationFilterList (list) -- [REQUIRED]

      Product information filters. The following filters and logical operators are supported:

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

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

      • (dict) --

        Describes product information filters.

        • ProductInformationFilterName (string) -- [REQUIRED]

          Filter name.

        • ProductInformationFilterValue (list) -- [REQUIRED]

          Filter value.

          • (string) --

        • ProductInformationFilterComparator (string) -- [REQUIRED]

          Logical operator.

rtype

dict

returns

Response Syntax

{
    'LicenseConfigurationArn': 'string'
}

Response Structure

  • (dict) --

    • LicenseConfigurationArn (string) --

      Amazon Resource Name (ARN) of the license configuration.

GetLicenseConfiguration (updated) Link ¶
Changes (response)
{'AutomatedDiscoveryInformation': {'LastRunTime': 'timestamp'},
 'ConsumedLicenseSummaryList': {'ResourceType': {'RDS',
                                                 'SYSTEMS_MANAGER_MANAGED_INSTANCE'}},
 'ManagedResourceSummaryList': {'ResourceType': {'RDS',
                                                 'SYSTEMS_MANAGER_MANAGED_INSTANCE'}},
 'ProductInformationList': [{'ProductInformationFilterList': [{'ProductInformationFilterComparator': 'string',
                                                               'ProductInformationFilterName': 'string',
                                                               'ProductInformationFilterValue': ['string']}],
                             'ResourceType': 'string'}]}

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)
    }
}

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 on 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 value is SSM_MANAGED .

        • ProductInformationFilterList (list) --

          Product information filters. The following filters and logical operators are supported:

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

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

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

GetServiceSettings (updated) Link ¶
Changes (response)
{'LicenseManagerResourceShareArn': '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'
}

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 AWS Organizations has been integrated with License Manager for cross-account discovery.

      • EnableIntegration (boolean) --

        Enables AWS Organization integration.

    • EnableCrossAccountsDiscovery (boolean) --

      Indicates whether cross-account discovery has been enabled.

    • LicenseManagerResourceShareArn (string) --

      Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account will provide member accounts with access to this share.

ListAssociationsForLicenseConfiguration (updated) Link ¶
Changes (response)
{'LicenseConfigurationAssociations': {'ResourceType': {'RDS',
                                                       'SYSTEMS_MANAGER_MANAGED_INSTANCE'}}}

Lists the resource associations for the specified license configuration.

Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).

See also: AWS API Documentation

Request Syntax

client.list_associations_for_license_configuration(
    LicenseConfigurationArn='string',
    MaxResults=123,
    NextToken='string'
)
type LicenseConfigurationArn

string

param LicenseConfigurationArn

[REQUIRED]

Amazon Resource Name (ARN) of a license configuration.

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

{
    'LicenseConfigurationAssociations': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
            'ResourceOwnerId': 'string',
            'AssociationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseConfigurationAssociations (list) --

      Information about the associations for the license configuration.

      • (dict) --

        Describes an association with a license configuration.

        • ResourceArn (string) --

          Amazon Resource Name (ARN) of the resource.

        • ResourceType (string) --

          Type of server resource.

        • ResourceOwnerId (string) --

          ID of the AWS account that owns the resource consuming licenses.

        • AssociationTime (datetime) --

          Time when the license configuration was associated with the resource.

    • NextToken (string) --

      Token for the next set of results.

ListLicenseConfigurations (updated) Link ¶
Changes (response)
{'LicenseConfigurations': {'AutomatedDiscoveryInformation': {'LastRunTime': 'timestamp'},
                           'ConsumedLicenseSummaryList': {'ResourceType': {'RDS',
                                                                           'SYSTEMS_MANAGER_MANAGED_INSTANCE'}},
                           'ManagedResourceSummaryList': {'ResourceType': {'RDS',
                                                                           'SYSTEMS_MANAGER_MANAGED_INSTANCE'}},
                           'ProductInformationList': [{'ProductInformationFilterList': [{'ProductInformationFilterComparator': 'string',
                                                                                         'ProductInformationFilterName': 'string',
                                                                                         'ProductInformationFilterValue': ['string']}],
                                                       'ResourceType': 'string'}]}}

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 on which licenses are counted (vCPU). Logical operators are EQUALS | NOT_EQUALS .

  • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS .

  • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS .

  • (dict) --

    A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      Name of the filter. Filter names are case-sensitive.

    • Values (list) --

      Filter values. Filter values are case-sensitive.

      • (string) --

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,
            '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)
            }
        },
    ],
    '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.

        • 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 value is SSM_MANAGED .

            • ProductInformationFilterList (list) --

              Product information filters. The following filters and logical operators are supported:

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

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

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

    • NextToken (string) --

      Token for the next set of results.

ListResourceInventory (updated) Link ¶
Changes (response)
{'ResourceInventoryList': {'ResourceType': {'RDS',
                                            'SYSTEMS_MANAGER_MANAGED_INSTANCE'}}}

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

  • (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'
        },
    ],
    '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.

    • NextToken (string) --

      Token for the next set of results.

ListUsageForLicenseConfiguration (updated) Link ¶
Changes (response)
{'LicenseConfigurationUsageList': {'ResourceType': {'RDS',
                                                    'SYSTEMS_MANAGER_MANAGED_INSTANCE'}}}

Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.

See also: AWS API Documentation

Request Syntax

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

string

param LicenseConfigurationArn

[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.

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:

  • resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS .

  • resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS .

  • resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS .

  • (dict) --

    A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      Name of the filter. Filter names are case-sensitive.

    • Values (list) --

      Filter values. Filter values are case-sensitive.

      • (string) --

rtype

dict

returns

Response Syntax

{
    'LicenseConfigurationUsageList': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
            'ResourceStatus': 'string',
            'ResourceOwnerId': 'string',
            'AssociationTime': datetime(2015, 1, 1),
            'ConsumedLicenses': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseConfigurationUsageList (list) --

      Information about the license configurations.

      • (dict) --

        Details about the usage of a resource associated with a license configuration.

        • ResourceArn (string) --

          Amazon Resource Name (ARN) of the resource.

        • ResourceType (string) --

          Type of resource.

        • ResourceStatus (string) --

          Status of the resource.

        • ResourceOwnerId (string) --

          ID of the account that owns the resource.

        • AssociationTime (datetime) --

          Time when the license configuration was initially associated with the resource.

        • ConsumedLicenses (integer) --

          Number of licenses consumed by the resource.

    • NextToken (string) --

      Token for the next set of results.

UpdateLicenseConfiguration (updated) Link ¶
Changes (request)
{'ProductInformationList': [{'ProductInformationFilterList': [{'ProductInformationFilterComparator': 'string',
                                                               'ProductInformationFilterName': 'string',
                                                               'ProductInformationFilterValue': ['string']}],
                             'ResourceType': 'string'}]}

Modifies the attributes of an existing 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), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.

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'
                },
            ]
        },
    ]
)
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 rules.

  • (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 value is SSM_MANAGED .

    • ProductInformationFilterList (list) -- [REQUIRED]

      Product information filters. The following filters and logical operators are supported:

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

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

      • (dict) --

        Describes product information filters.

        • ProductInformationFilterName (string) -- [REQUIRED]

          Filter name.

        • ProductInformationFilterValue (list) -- [REQUIRED]

          Filter value.

          • (string) --

        • ProductInformationFilterComparator (string) -- [REQUIRED]

          Logical operator.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --