LicenseManager

Client

class LicenseManager.Client

A low-level client representing AWS License Manager

AWS License Manager makes it easier to manage licenses from software vendors across multiple AWS accounts and on-premises servers.

client = session.create_client('license-manager')

These are the available methods:

accept_grant(**kwargs)

Accepts the specified grant.

See also: AWS API Documentation

Request Syntax

response = client.accept_grant(
    GrantArn='string'
)
Parameters
GrantArn (string) --

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

Return type
dict
Returns
Response Syntax
{
    'GrantArn': 'string',
    'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
    'Version': 'string'
}

Response Structure

  • (dict) --
    • GrantArn (string) --

      Grant ARN.

    • Status (string) --

      Grant status.

    • Version (string) --

      Grant version.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
check_in_license(**kwargs)

Checks in the specified license. Check in a license when it is no longer in use.

See also: AWS API Documentation

Request Syntax

response = client.check_in_license(
    LicenseConsumptionToken='string',
    Beneficiary='string'
)
Parameters
  • LicenseConsumptionToken (string) --

    [REQUIRED]

    License consumption token.

  • Beneficiary (string) -- License beneficiary.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

checkout_borrow_license(**kwargs)

Checks out the specified license for offline use.

See also: AWS API Documentation

Request Syntax

response = client.checkout_borrow_license(
    LicenseArn='string',
    Entitlements=[
        {
            'Name': 'string',
            'Value': 'string',
            'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'
        },
    ],
    DigitalSignatureMethod='JWT_PS384',
    NodeId='string',
    CheckoutMetadata=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters
  • LicenseArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

  • Entitlements (list) --

    [REQUIRED]

    License entitlements. Partial checkouts are not supported.

    • (dict) --

      Data associated with an entitlement resource.

      • Name (string) -- [REQUIRED]

        Entitlement data name.

      • Value (string) --

        Entitlement data value.

      • Unit (string) -- [REQUIRED]

        Entitlement data unit.

  • DigitalSignatureMethod (string) --

    [REQUIRED]

    Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS .

  • NodeId (string) -- Node ID.
  • CheckoutMetadata (list) --

    Information about constraints.

    • (dict) --

      Describes key/value pairs.

      • Name (string) --

        The key name.

      • Value (string) --

        The value.

  • ClientToken (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'LicenseArn': 'string',
    'LicenseConsumptionToken': 'string',
    'EntitlementsAllowed': [
        {
            'Name': 'string',
            'Value': 'string',
            'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'
        },
    ],
    'NodeId': 'string',
    'SignedToken': 'string',
    'IssuedAt': 'string',
    'Expiration': 'string',
    'CheckoutMetadata': [
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • LicenseArn (string) --

      Amazon Resource Name (ARN) of the license.

    • LicenseConsumptionToken (string) --

      License consumption token.

    • EntitlementsAllowed (list) --

      Allowed license entitlements.

      • (dict) --

        Data associated with an entitlement resource.

        • Name (string) --

          Entitlement data name.

        • Value (string) --

          Entitlement data value.

        • Unit (string) --

          Entitlement data unit.

    • NodeId (string) --

      Node ID.

    • SignedToken (string) --

      Signed token.

    • IssuedAt (string) --

      Date and time at which the license checkout is issued.

    • Expiration (string) --

      Date and time at which the license checkout expires.

    • CheckoutMetadata (list) --

      Information about constraints.

      • (dict) --

        Describes key/value pairs.

        • Name (string) --

          The key name.

        • Value (string) --

          The value.

Exceptions

checkout_license(**kwargs)

Checks out the specified license.

See also: AWS API Documentation

Request Syntax

response = client.checkout_license(
    ProductSKU='string',
    CheckoutType='PROVISIONAL',
    KeyFingerprint='string',
    Entitlements=[
        {
            'Name': 'string',
            'Value': 'string',
            'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'
        },
    ],
    ClientToken='string',
    Beneficiary='string',
    NodeId='string'
)
Parameters
  • ProductSKU (string) --

    [REQUIRED]

    Product SKU.

  • CheckoutType (string) --

    [REQUIRED]

    Checkout type.

  • KeyFingerprint (string) --

    [REQUIRED]

    Key fingerprint identifying the license.

  • Entitlements (list) --

    [REQUIRED]

    License entitlements.

    • (dict) --

      Data associated with an entitlement resource.

      • Name (string) -- [REQUIRED]

        Entitlement data name.

      • Value (string) --

        Entitlement data value.

      • Unit (string) -- [REQUIRED]

        Entitlement data unit.

  • ClientToken (string) --

    [REQUIRED]

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

  • Beneficiary (string) -- License beneficiary.
  • NodeId (string) -- Node ID.
Return type

dict

Returns

Response Syntax

{
    'CheckoutType': 'PROVISIONAL',
    'LicenseConsumptionToken': 'string',
    'EntitlementsAllowed': [
        {
            'Name': 'string',
            'Value': 'string',
            'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'
        },
    ],
    'SignedToken': 'string',
    'NodeId': 'string',
    'IssuedAt': 'string',
    'Expiration': 'string'
}

Response Structure

  • (dict) --

    • CheckoutType (string) --

      Checkout type.

    • LicenseConsumptionToken (string) --

      License consumption token.

    • EntitlementsAllowed (list) --

      Allowed license entitlements.

      • (dict) --

        Data associated with an entitlement resource.

        • Name (string) --

          Entitlement data name.

        • Value (string) --

          Entitlement data value.

        • Unit (string) --

          Entitlement data unit.

    • SignedToken (string) --

      Signed token.

    • NodeId (string) --

      Node ID.

    • IssuedAt (string) --

      Date and time at which the license checkout is issued.

    • Expiration (string) --

      Date and time at which the license checkout expires.

Exceptions

create_grant(**kwargs)

Creates a grant for the specified license. A grant shares the use of license entitlements with specific AWS accounts.

See also: AWS API Documentation

Request Syntax

response = client.create_grant(
    ClientToken='string',
    GrantName='string',
    LicenseArn='string',
    Principals=[
        'string',
    ],
    HomeRegion='string',
    AllowedOperations=[
        'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
    ]
)
Parameters
  • ClientToken (string) --

    [REQUIRED]

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

  • GrantName (string) --

    [REQUIRED]

    Grant name.

  • LicenseArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license.

  • Principals (list) --

    [REQUIRED]

    The grant principals.

    • (string) --
  • HomeRegion (string) --

    [REQUIRED]

    Home Region of the grant.

  • AllowedOperations (list) --

    [REQUIRED]

    Allowed operations for the grant.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'GrantArn': 'string',
    'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
    'Version': 'string'
}

Response Structure

  • (dict) --

    • GrantArn (string) --

      Grant ARN.

    • Status (string) --

      Grant status.

    • Version (string) --

      Grant version.

Exceptions

create_grant_version(**kwargs)

Creates a new version of the specified grant.

See also: AWS API Documentation

Request Syntax

response = client.create_grant_version(
    ClientToken='string',
    GrantArn='string',
    GrantName='string',
    AllowedOperations=[
        'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
    ],
    Status='PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
    SourceVersion='string'
)
Parameters
  • ClientToken (string) --

    [REQUIRED]

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

  • GrantArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the grant.

  • GrantName (string) -- Grant name.
  • AllowedOperations (list) --

    Allowed operations for the grant.

    • (string) --
  • Status (string) -- Grant status.
  • SourceVersion (string) -- Current version of the grant.
Return type

dict

Returns

Response Syntax

{
    'GrantArn': 'string',
    'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
    'Version': 'string'
}

Response Structure

  • (dict) --

    • GrantArn (string) --

      Grant ARN.

    • Status (string) --

      Grant status.

    • Version (string) --

      New version of the grant.

Exceptions

create_license(**kwargs)

Creates a license.

See also: AWS API Documentation

Request Syntax

response = client.create_license(
    LicenseName='string',
    ProductName='string',
    ProductSKU='string',
    Issuer={
        'Name': 'string',
        'SignKey': 'string'
    },
    HomeRegion='string',
    Validity={
        'Begin': 'string',
        'End': 'string'
    },
    Entitlements=[
        {
            'Name': 'string',
            'Value': 'string',
            'MaxCount': 123,
            'Overage': True|False,
            'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second',
            'AllowCheckIn': True|False
        },
    ],
    Beneficiary='string',
    ConsumptionConfiguration={
        'RenewType': 'None'|'Weekly'|'Monthly',
        'ProvisionalConfiguration': {
            'MaxTimeToLiveInMinutes': 123
        },
        'BorrowConfiguration': {
            'AllowEarlyCheckIn': True|False,
            'MaxTimeToLiveInMinutes': 123
        }
    },
    LicenseMetadata=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters
  • LicenseName (string) --

    [REQUIRED]

    License name.

  • ProductName (string) --

    [REQUIRED]

    Product name.

  • ProductSKU (string) --

    [REQUIRED]

    Product SKU.

  • Issuer (dict) --

    [REQUIRED]

    License issuer.

    • Name (string) -- [REQUIRED]

      Issuer name.

    • SignKey (string) --

      Asymmetric CMK from AWS Key Management Service. The CMK must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

  • HomeRegion (string) --

    [REQUIRED]

    Home Region for the license.

  • Validity (dict) --

    [REQUIRED]

    Date and time range during which the license is valid, in ISO8601-UTC format.

    • Begin (string) -- [REQUIRED]

      Start of the time range.

    • End (string) --

      End of the time range.

  • Entitlements (list) --

    [REQUIRED]

    License entitlements.

    • (dict) --

      Describes a resource entitled for use with a license.

      • Name (string) -- [REQUIRED]

        Entitlement name.

      • Value (string) --

        Entitlement resource. Use only if the unit is None.

      • MaxCount (integer) --

        Maximum entitlement count. Use if the unit is not None.

      • Overage (boolean) --

        Indicates whether overages are allowed.

      • Unit (string) -- [REQUIRED]

        Entitlement unit.

      • AllowCheckIn (boolean) --

        Indicates whether check-ins are allowed.

  • Beneficiary (string) --

    [REQUIRED]

    License beneficiary.

  • ConsumptionConfiguration (dict) --

    [REQUIRED]

    Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

    • RenewType (string) --

      Renewal frequency.

    • ProvisionalConfiguration (dict) --

      Details about a provisional configuration.

      • MaxTimeToLiveInMinutes (integer) -- [REQUIRED]

        Maximum time for the provisional configuration, in minutes.

    • BorrowConfiguration (dict) --

      Details about a borrow configuration.

      • AllowEarlyCheckIn (boolean) -- [REQUIRED]

        Indicates whether early check-ins are allowed.

      • MaxTimeToLiveInMinutes (integer) -- [REQUIRED]

        Maximum time for the borrow configuration, in minutes.

  • LicenseMetadata (list) --

    Information about the license.

    • (dict) --

      Describes key/value pairs.

      • Name (string) --

        The key name.

      • Value (string) --

        The value.

  • ClientToken (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'LicenseArn': 'string',
    'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
    'Version': 'string'
}

Response Structure

  • (dict) --

    • LicenseArn (string) --

      Amazon Resource Name (ARN) of the license.

    • Status (string) --

      License status.

    • Version (string) --

      License version.

Exceptions

create_license_configuration(**kwargs)

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

response = 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'
                },
            ]
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the license configuration.

  • Description (string) -- Description of the license configuration.
  • LicenseCountingType (string) --

    [REQUIRED]

    Dimension used to track the license inventory.

  • LicenseCount (integer) -- Number of licenses managed by the license configuration.
  • LicenseCountHardLimit (boolean) -- Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
  • LicenseRules (list) --

    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 | maximumCores | minimumCores | maximumSockets | minimumSockets | 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) --
  • Tags (list) --

    Tags to add to the license configuration.

    • (dict) --

      Details about a tag for a license configuration.

      • Key (string) --

        Tag key.

      • Value (string) --

        Tag value.

  • DisassociateWhenNotFound (boolean) -- When true, disassociates a resource when software is uninstalled.
  • ProductInformationList (list) --

    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]

        Product information filters.

        The following filters and logical operators 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 .
        • 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) -- [REQUIRED]

            Filter name.

          • ProductInformationFilterValue (list) -- [REQUIRED]

            Filter value.

            • (string) --
          • ProductInformationFilterComparator (string) -- [REQUIRED]

            Logical operator.

Return type

dict

Returns

Response Syntax

{
    'LicenseConfigurationArn': 'string'
}

Response Structure

  • (dict) --

    • LicenseConfigurationArn (string) --

      Amazon Resource Name (ARN) of the license configuration.

Exceptions

create_license_version(**kwargs)

Creates a new version of the specified license.

See also: AWS API Documentation

Request Syntax

response = client.create_license_version(
    LicenseArn='string',
    LicenseName='string',
    ProductName='string',
    Issuer={
        'Name': 'string',
        'SignKey': 'string'
    },
    HomeRegion='string',
    Validity={
        'Begin': 'string',
        'End': 'string'
    },
    LicenseMetadata=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    Entitlements=[
        {
            'Name': 'string',
            'Value': 'string',
            'MaxCount': 123,
            'Overage': True|False,
            'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second',
            'AllowCheckIn': True|False
        },
    ],
    ConsumptionConfiguration={
        'RenewType': 'None'|'Weekly'|'Monthly',
        'ProvisionalConfiguration': {
            'MaxTimeToLiveInMinutes': 123
        },
        'BorrowConfiguration': {
            'AllowEarlyCheckIn': True|False,
            'MaxTimeToLiveInMinutes': 123
        }
    },
    Status='AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
    ClientToken='string',
    SourceVersion='string'
)
Parameters
  • LicenseArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license.

  • LicenseName (string) --

    [REQUIRED]

    License name.

  • ProductName (string) --

    [REQUIRED]

    Product name.

  • Issuer (dict) --

    [REQUIRED]

    License issuer.

    • Name (string) -- [REQUIRED]

      Issuer name.

    • SignKey (string) --

      Asymmetric CMK from AWS Key Management Service. The CMK must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

  • HomeRegion (string) --

    [REQUIRED]

    Home Region of the license.

  • Validity (dict) --

    [REQUIRED]

    Date and time range during which the license is valid, in ISO8601-UTC format.

    • Begin (string) -- [REQUIRED]

      Start of the time range.

    • End (string) --

      End of the time range.

  • LicenseMetadata (list) --

    Information about the license.

    • (dict) --

      Describes key/value pairs.

      • Name (string) --

        The key name.

      • Value (string) --

        The value.

  • Entitlements (list) --

    [REQUIRED]

    License entitlements.

    • (dict) --

      Describes a resource entitled for use with a license.

      • Name (string) -- [REQUIRED]

        Entitlement name.

      • Value (string) --

        Entitlement resource. Use only if the unit is None.

      • MaxCount (integer) --

        Maximum entitlement count. Use if the unit is not None.

      • Overage (boolean) --

        Indicates whether overages are allowed.

      • Unit (string) -- [REQUIRED]

        Entitlement unit.

      • AllowCheckIn (boolean) --

        Indicates whether check-ins are allowed.

  • ConsumptionConfiguration (dict) --

    [REQUIRED]

    Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

    • RenewType (string) --

      Renewal frequency.

    • ProvisionalConfiguration (dict) --

      Details about a provisional configuration.

      • MaxTimeToLiveInMinutes (integer) -- [REQUIRED]

        Maximum time for the provisional configuration, in minutes.

    • BorrowConfiguration (dict) --

      Details about a borrow configuration.

      • AllowEarlyCheckIn (boolean) -- [REQUIRED]

        Indicates whether early check-ins are allowed.

      • MaxTimeToLiveInMinutes (integer) -- [REQUIRED]

        Maximum time for the borrow configuration, in minutes.

  • Status (string) --

    [REQUIRED]

    License status.

  • ClientToken (string) --

    [REQUIRED]

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

  • SourceVersion (string) -- Current version of the license.
Return type

dict

Returns

Response Syntax

{
    'LicenseArn': 'string',
    'Version': 'string',
    'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED'
}

Response Structure

  • (dict) --

    • LicenseArn (string) --

      License ARN.

    • Version (string) --

      New version of the license.

    • Status (string) --

      License status.

Exceptions

create_token(**kwargs)

Creates a long-lived token.

A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.

See also: AWS API Documentation

Request Syntax

response = client.create_token(
    LicenseArn='string',
    RoleArns=[
        'string',
    ],
    ExpirationInDays=123,
    TokenProperties=[
        'string',
    ],
    ClientToken='string'
)
Parameters
  • LicenseArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

  • RoleArns (list) --

    Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

    • (string) --
  • ExpirationInDays (integer) -- Token expiration, in days, counted from token creation. The default is 365 days.
  • TokenProperties (list) --

    Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

    • (string) --
  • ClientToken (string) --

    [REQUIRED]

    Idempotency token, valid for 10 minutes.

Return type

dict

Returns

Response Syntax

{
    'TokenId': 'string',
    'TokenType': 'REFRESH_TOKEN',
    'Token': 'string'
}

Response Structure

  • (dict) --

    • TokenId (string) --

      Token ID.

    • TokenType (string) --

      Token type.

    • Token (string) --

      Refresh token, encoded as a JWT token.

Exceptions

delete_grant(**kwargs)

Deletes the specified grant.

See also: AWS API Documentation

Request Syntax

response = client.delete_grant(
    GrantArn='string',
    Version='string'
)
Parameters
  • GrantArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the grant.

  • Version (string) --

    [REQUIRED]

    Current version of the grant.

Return type

dict

Returns

Response Syntax

{
    'GrantArn': 'string',
    'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
    'Version': 'string'
}

Response Structure

  • (dict) --

    • GrantArn (string) --

      Grant ARN.

    • Status (string) --

      Grant status.

    • Version (string) --

      Grant version.

Exceptions

delete_license(**kwargs)

Deletes the specified license.

See also: AWS API Documentation

Request Syntax

response = client.delete_license(
    LicenseArn='string',
    SourceVersion='string'
)
Parameters
  • LicenseArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license.

  • SourceVersion (string) --

    [REQUIRED]

    Current version of the license.

Return type

dict

Returns

Response Syntax

{
    'Status': 'PENDING_DELETE'|'DELETED',
    'DeletionDate': 'string'
}

Response Structure

  • (dict) --

    • Status (string) --

      License status.

    • DeletionDate (string) --

      Date on which the license is deleted.

Exceptions

delete_license_configuration(**kwargs)

Deletes the specified license configuration.

You cannot delete a license configuration that is in use.

See also: AWS API Documentation

Request Syntax

response = client.delete_license_configuration(
    LicenseConfigurationArn='string'
)
Parameters
LicenseConfigurationArn (string) --

[REQUIRED]

ID of the license configuration.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_token(**kwargs)

Deletes the specified token. Must be called in the license home Region.

See also: AWS API Documentation

Request Syntax

response = client.delete_token(
    TokenId='string'
)
Parameters
TokenId (string) --

[REQUIRED]

Token ID.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

extend_license_consumption(**kwargs)

Extends the expiration date for license consumption.

See also: AWS API Documentation

Request Syntax

response = client.extend_license_consumption(
    LicenseConsumptionToken='string',
    DryRun=True|False
)
Parameters
  • LicenseConsumptionToken (string) --

    [REQUIRED]

    License consumption token.

  • DryRun (boolean) -- Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.
Return type

dict

Returns

Response Syntax

{
    'LicenseConsumptionToken': 'string',
    'Expiration': 'string'
}

Response Structure

  • (dict) --

    • LicenseConsumptionToken (string) --

      License consumption token.

    • Expiration (string) --

      Date and time at which the license consumption expires.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_access_token(**kwargs)

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.

See also: AWS API Documentation

Request Syntax

response = client.get_access_token(
    Token='string',
    TokenProperties=[
        'string',
    ]
)
Parameters
  • Token (string) --

    [REQUIRED]

    Refresh token, encoded as a JWT token.

  • TokenProperties (list) --

    Token properties to validate against those present in the JWT token.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'AccessToken': 'string'
}

Response Structure

  • (dict) --

    • AccessToken (string) --

      Temporary access token.

Exceptions

get_grant(**kwargs)

Gets detailed information about the specified grant.

See also: AWS API Documentation

Request Syntax

response = client.get_grant(
    GrantArn='string',
    Version='string'
)
Parameters
  • GrantArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the grant.

  • Version (string) -- Grant version.
Return type

dict

Returns

Response Syntax

{
    'Grant': {
        'GrantArn': 'string',
        'GrantName': 'string',
        'ParentArn': 'string',
        'LicenseArn': 'string',
        'GranteePrincipalArn': 'string',
        'HomeRegion': 'string',
        'GrantStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
        'StatusReason': 'string',
        'Version': 'string',
        'GrantedOperations': [
            'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
        ]
    }
}

Response Structure

  • (dict) --

    • Grant (dict) --

      Grant details.

      • GrantArn (string) --

        Amazon Resource Name (ARN) of the grant.

      • GrantName (string) --

        Grant name.

      • ParentArn (string) --

        Parent ARN.

      • LicenseArn (string) --

        License ARN.

      • GranteePrincipalArn (string) --

        The grantee principal ARN.

      • HomeRegion (string) --

        Home Region of the grant.

      • GrantStatus (string) --

        Grant status.

      • StatusReason (string) --

        Grant status reason.

      • Version (string) --

        Grant version.

      • GrantedOperations (list) --

        Granted operations.

        • (string) --

Exceptions

get_license(**kwargs)

Gets detailed information about the specified license.

See also: AWS API Documentation

Request Syntax

response = client.get_license(
    LicenseArn='string',
    Version='string'
)
Parameters
  • LicenseArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license.

  • Version (string) -- License version.
Return type

dict

Returns

Response Syntax

{
    'License': {
        'LicenseArn': 'string',
        'LicenseName': 'string',
        'ProductName': 'string',
        'ProductSKU': 'string',
        'Issuer': {
            'Name': 'string',
            'SignKey': 'string',
            'KeyFingerprint': 'string'
        },
        'HomeRegion': 'string',
        'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
        'Validity': {
            'Begin': 'string',
            'End': 'string'
        },
        'Beneficiary': 'string',
        'Entitlements': [
            {
                'Name': 'string',
                'Value': 'string',
                'MaxCount': 123,
                'Overage': True|False,
                'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second',
                'AllowCheckIn': True|False
            },
        ],
        'ConsumptionConfiguration': {
            'RenewType': 'None'|'Weekly'|'Monthly',
            'ProvisionalConfiguration': {
                'MaxTimeToLiveInMinutes': 123
            },
            'BorrowConfiguration': {
                'AllowEarlyCheckIn': True|False,
                'MaxTimeToLiveInMinutes': 123
            }
        },
        'LicenseMetadata': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'CreateTime': 'string',
        'Version': 'string'
    }
}

Response Structure

  • (dict) --

    • License (dict) --

      License details.

      • LicenseArn (string) --

        Amazon Resource Name (ARN) of the license.

      • LicenseName (string) --

        License name.

      • ProductName (string) --

        Product name.

      • ProductSKU (string) --

        Product SKU.

      • Issuer (dict) --

        License issuer.

        • Name (string) --

          Issuer name.

        • SignKey (string) --

          Asymmetric CMK from AWS Key Management Service. The CMK must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

        • KeyFingerprint (string) --

          Issuer key fingerprint.

      • HomeRegion (string) --

        Home Region of the license.

      • Status (string) --

        License status.

      • Validity (dict) --

        Date and time range during which the license is valid, in ISO8601-UTC format.

        • Begin (string) --

          Start of the time range.

        • End (string) --

          End of the time range.

      • Beneficiary (string) --

        License beneficiary.

      • Entitlements (list) --

        License entitlements.

        • (dict) --

          Describes a resource entitled for use with a license.

          • Name (string) --

            Entitlement name.

          • Value (string) --

            Entitlement resource. Use only if the unit is None.

          • MaxCount (integer) --

            Maximum entitlement count. Use if the unit is not None.

          • Overage (boolean) --

            Indicates whether overages are allowed.

          • Unit (string) --

            Entitlement unit.

          • AllowCheckIn (boolean) --

            Indicates whether check-ins are allowed.

      • ConsumptionConfiguration (dict) --

        Configuration for consumption of the license.

        • RenewType (string) --

          Renewal frequency.

        • ProvisionalConfiguration (dict) --

          Details about a provisional configuration.

          • MaxTimeToLiveInMinutes (integer) --

            Maximum time for the provisional configuration, in minutes.

        • BorrowConfiguration (dict) --

          Details about a borrow configuration.

          • AllowEarlyCheckIn (boolean) --

            Indicates whether early check-ins are allowed.

          • MaxTimeToLiveInMinutes (integer) --

            Maximum time for the borrow configuration, in minutes.

      • LicenseMetadata (list) --

        License metadata.

        • (dict) --

          Describes key/value pairs.

          • Name (string) --

            The key name.

          • Value (string) --

            The value.

      • CreateTime (string) --

        License creation time.

      • Version (string) --

        License version.

Exceptions

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 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 possible values are SSM_MANAGED | RDS .

        • ProductInformationFilterList (list) --

          Product information filters.

          The following filters and logical operators 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 .
          • 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

get_license_usage(**kwargs)

Gets detailed information about the usage of the specified license.

See also: AWS API Documentation

Request Syntax

response = client.get_license_usage(
    LicenseArn='string'
)
Parameters
LicenseArn (string) --

[REQUIRED]

Amazon Resource Name (ARN) of the license.

Return type
dict
Returns
Response Syntax
{
    'LicenseUsage': {
        'EntitlementUsages': [
            {
                'Name': 'string',
                'ConsumedValue': 'string',
                'MaxCount': 'string',
                'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • LicenseUsage (dict) --

      License usage details.

      • EntitlementUsages (list) --

        License entitlement usages.

        • (dict) --

          Usage associated with an entitlement resource.

          • Name (string) --

            Entitlement usage name.

          • ConsumedValue (string) --

            Resource usage consumed.

          • MaxCount (string) --

            Maximum entitlement usage count.

          • Unit (string) --

            Entitlement usage unit.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_service_settings()

Gets the License Manager settings for the current Region.

See also: AWS API Documentation

Request Syntax

response = client.get_service_settings()
Return type
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 is integrated with License Manager for cross-account discovery.

      • EnableIntegration (boolean) --

        Enables AWS Organization integration.

    • EnableCrossAccountsDiscovery (boolean) --

      Indicates whether cross-account discovery is 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.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_associations_for_license_configuration(**kwargs)

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

response = client.list_associations_for_license_configuration(
    LicenseConfigurationArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • LicenseConfigurationArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of a license configuration.

  • MaxResults (integer) -- Maximum number of results to return in a single call.
  • NextToken (string) -- Token for the next set of results.
Return type

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

        • AmiAssociationScope (string) --

          Scope of AMI associations. The possible value is cross-account .

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_distributed_grants(**kwargs)

Lists the grants distributed for the specified license.

See also: AWS API Documentation

Request Syntax

response = client.list_distributed_grants(
    GrantArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • GrantArns (list) --

    Amazon Resource Names (ARNs) of the grants.

    • (string) --
  • Filters (list) --

    Filters to scope the results. The following filters are supported:

    • LicenseARN
    • Status
    • PrincipalARN
    • ParentARN
    • (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) --
  • NextToken (string) -- Token for the next set of results.
  • MaxResults (integer) -- Maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Grants': [
        {
            'GrantArn': 'string',
            'GrantName': 'string',
            'ParentArn': 'string',
            'LicenseArn': 'string',
            'GranteePrincipalArn': 'string',
            'HomeRegion': 'string',
            'GrantStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
            'StatusReason': 'string',
            'Version': 'string',
            'GrantedOperations': [
                'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Grants (list) --

      Distributed grant details.

      • (dict) --

        Describes a grant.

        • GrantArn (string) --

          Amazon Resource Name (ARN) of the grant.

        • GrantName (string) --

          Grant name.

        • ParentArn (string) --

          Parent ARN.

        • LicenseArn (string) --

          License ARN.

        • GranteePrincipalArn (string) --

          The grantee principal ARN.

        • HomeRegion (string) --

          Home Region of the grant.

        • GrantStatus (string) --

          Grant status.

        • StatusReason (string) --

          Grant status reason.

        • Version (string) --

          Grant version.

        • GrantedOperations (list) --

          Granted operations.

          • (string) --
    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_failures_for_license_configuration_operations(**kwargs)

Lists the license configuration operations that failed.

See also: AWS API Documentation

Request Syntax

response = client.list_failures_for_license_configuration_operations(
    LicenseConfigurationArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • LicenseConfigurationArn (string) --

    [REQUIRED]

    Amazon Resource Name of the license configuration.

  • MaxResults (integer) -- Maximum number of results to return in a single call.
  • NextToken (string) -- Token for the next set of results.
Return type

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

            Describes key/value pairs.

            • Name (string) --

              The key name.

            • Value (string) --

              The value.

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_license_configurations(**kwargs)

Lists the license configurations for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_license_configurations(
    LicenseConfigurationArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • LicenseConfigurationArns (list) --

    Amazon Resource Names (ARN) of the license configurations.

    • (string) --
  • MaxResults (integer) -- Maximum number of results to return in a single call.
  • NextToken (string) -- Token for the next set of results.
  • Filters (list) --

    Filters to scope the results. The following filters and logical operators are supported:

    • licenseCountingType - The dimension on which licenses are counted. Possible values are vCPU | Instance | Core | Socket . 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) --
Return type

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

              Product information filters.

              The following filters and logical operators 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 .
              • 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.

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_license_specifications_for_resource(**kwargs)

Describes the license configurations for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_license_specifications_for_resource(
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of a resource that has an associated license configuration.

  • MaxResults (integer) -- Maximum number of results to return in a single call.
  • NextToken (string) -- Token for the next set of results.
Return type

dict

Returns

Response Syntax

{
    'LicenseSpecifications': [
        {
            'LicenseConfigurationArn': 'string',
            'AmiAssociationScope': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LicenseSpecifications (list) --

      License configurations associated with a resource.

      • (dict) --

        Details for associating a license configuration with a resource.

        • LicenseConfigurationArn (string) --

          Amazon Resource Name (ARN) of the license configuration.

        • AmiAssociationScope (string) --

          Scope of AMI associations. The possible value is cross-account .

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_license_versions(**kwargs)

Lists all versions of the specified license.

See also: AWS API Documentation

Request Syntax

response = client.list_license_versions(
    LicenseArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • LicenseArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license.

  • NextToken (string) -- Token for the next set of results.
  • MaxResults (integer) -- Maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Licenses': [
        {
            'LicenseArn': 'string',
            'LicenseName': 'string',
            'ProductName': 'string',
            'ProductSKU': 'string',
            'Issuer': {
                'Name': 'string',
                'SignKey': 'string',
                'KeyFingerprint': 'string'
            },
            'HomeRegion': 'string',
            'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
            'Validity': {
                'Begin': 'string',
                'End': 'string'
            },
            'Beneficiary': 'string',
            'Entitlements': [
                {
                    'Name': 'string',
                    'Value': 'string',
                    'MaxCount': 123,
                    'Overage': True|False,
                    'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second',
                    'AllowCheckIn': True|False
                },
            ],
            'ConsumptionConfiguration': {
                'RenewType': 'None'|'Weekly'|'Monthly',
                'ProvisionalConfiguration': {
                    'MaxTimeToLiveInMinutes': 123
                },
                'BorrowConfiguration': {
                    'AllowEarlyCheckIn': True|False,
                    'MaxTimeToLiveInMinutes': 123
                }
            },
            'LicenseMetadata': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'CreateTime': 'string',
            'Version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Licenses (list) --

      License details.

      • (dict) --

        Software license that is managed in AWS License Manager.

        • LicenseArn (string) --

          Amazon Resource Name (ARN) of the license.

        • LicenseName (string) --

          License name.

        • ProductName (string) --

          Product name.

        • ProductSKU (string) --

          Product SKU.

        • Issuer (dict) --

          License issuer.

          • Name (string) --

            Issuer name.

          • SignKey (string) --

            Asymmetric CMK from AWS Key Management Service. The CMK must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

          • KeyFingerprint (string) --

            Issuer key fingerprint.

        • HomeRegion (string) --

          Home Region of the license.

        • Status (string) --

          License status.

        • Validity (dict) --

          Date and time range during which the license is valid, in ISO8601-UTC format.

          • Begin (string) --

            Start of the time range.

          • End (string) --

            End of the time range.

        • Beneficiary (string) --

          License beneficiary.

        • Entitlements (list) --

          License entitlements.

          • (dict) --

            Describes a resource entitled for use with a license.

            • Name (string) --

              Entitlement name.

            • Value (string) --

              Entitlement resource. Use only if the unit is None.

            • MaxCount (integer) --

              Maximum entitlement count. Use if the unit is not None.

            • Overage (boolean) --

              Indicates whether overages are allowed.

            • Unit (string) --

              Entitlement unit.

            • AllowCheckIn (boolean) --

              Indicates whether check-ins are allowed.

        • ConsumptionConfiguration (dict) --

          Configuration for consumption of the license.

          • RenewType (string) --

            Renewal frequency.

          • ProvisionalConfiguration (dict) --

            Details about a provisional configuration.

            • MaxTimeToLiveInMinutes (integer) --

              Maximum time for the provisional configuration, in minutes.

          • BorrowConfiguration (dict) --

            Details about a borrow configuration.

            • AllowEarlyCheckIn (boolean) --

              Indicates whether early check-ins are allowed.

            • MaxTimeToLiveInMinutes (integer) --

              Maximum time for the borrow configuration, in minutes.

        • LicenseMetadata (list) --

          License metadata.

          • (dict) --

            Describes key/value pairs.

            • Name (string) --

              The key name.

            • Value (string) --

              The value.

        • CreateTime (string) --

          License creation time.

        • Version (string) --

          License version.

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_licenses(**kwargs)

Lists the licenses for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_licenses(
    LicenseArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • LicenseArns (list) --

    Amazon Resource Names (ARNs) of the licenses.

    • (string) --
  • Filters (list) --

    Filters to scope the results. The following filters are supported:

    • Beneficiary
    • ProductSKU
    • KeyFingerprint
    • Status
    • (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) --
  • NextToken (string) -- Token for the next set of results.
  • MaxResults (integer) -- Maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Licenses': [
        {
            'LicenseArn': 'string',
            'LicenseName': 'string',
            'ProductName': 'string',
            'ProductSKU': 'string',
            'Issuer': {
                'Name': 'string',
                'SignKey': 'string',
                'KeyFingerprint': 'string'
            },
            'HomeRegion': 'string',
            'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
            'Validity': {
                'Begin': 'string',
                'End': 'string'
            },
            'Beneficiary': 'string',
            'Entitlements': [
                {
                    'Name': 'string',
                    'Value': 'string',
                    'MaxCount': 123,
                    'Overage': True|False,
                    'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second',
                    'AllowCheckIn': True|False
                },
            ],
            'ConsumptionConfiguration': {
                'RenewType': 'None'|'Weekly'|'Monthly',
                'ProvisionalConfiguration': {
                    'MaxTimeToLiveInMinutes': 123
                },
                'BorrowConfiguration': {
                    'AllowEarlyCheckIn': True|False,
                    'MaxTimeToLiveInMinutes': 123
                }
            },
            'LicenseMetadata': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'CreateTime': 'string',
            'Version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Licenses (list) --

      License details.

      • (dict) --

        Software license that is managed in AWS License Manager.

        • LicenseArn (string) --

          Amazon Resource Name (ARN) of the license.

        • LicenseName (string) --

          License name.

        • ProductName (string) --

          Product name.

        • ProductSKU (string) --

          Product SKU.

        • Issuer (dict) --

          License issuer.

          • Name (string) --

            Issuer name.

          • SignKey (string) --

            Asymmetric CMK from AWS Key Management Service. The CMK must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

          • KeyFingerprint (string) --

            Issuer key fingerprint.

        • HomeRegion (string) --

          Home Region of the license.

        • Status (string) --

          License status.

        • Validity (dict) --

          Date and time range during which the license is valid, in ISO8601-UTC format.

          • Begin (string) --

            Start of the time range.

          • End (string) --

            End of the time range.

        • Beneficiary (string) --

          License beneficiary.

        • Entitlements (list) --

          License entitlements.

          • (dict) --

            Describes a resource entitled for use with a license.

            • Name (string) --

              Entitlement name.

            • Value (string) --

              Entitlement resource. Use only if the unit is None.

            • MaxCount (integer) --

              Maximum entitlement count. Use if the unit is not None.

            • Overage (boolean) --

              Indicates whether overages are allowed.

            • Unit (string) --

              Entitlement unit.

            • AllowCheckIn (boolean) --

              Indicates whether check-ins are allowed.

        • ConsumptionConfiguration (dict) --

          Configuration for consumption of the license.

          • RenewType (string) --

            Renewal frequency.

          • ProvisionalConfiguration (dict) --

            Details about a provisional configuration.

            • MaxTimeToLiveInMinutes (integer) --

              Maximum time for the provisional configuration, in minutes.

          • BorrowConfiguration (dict) --

            Details about a borrow configuration.

            • AllowEarlyCheckIn (boolean) --

              Indicates whether early check-ins are allowed.

            • MaxTimeToLiveInMinutes (integer) --

              Maximum time for the borrow configuration, in minutes.

        • LicenseMetadata (list) --

          License metadata.

          • (dict) --

            Describes key/value pairs.

            • Name (string) --

              The key name.

            • Value (string) --

              The value.

        • CreateTime (string) --

          License creation time.

        • Version (string) --

          License version.

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_received_grants(**kwargs)

Lists grants that are received but not accepted.

See also: AWS API Documentation

Request Syntax

response = client.list_received_grants(
    GrantArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • GrantArns (list) --

    Amazon Resource Names (ARNs) of the grants.

    • (string) --
  • Filters (list) --

    Filters to scope the results. The following filters are supported:

    • LicenseARN
    • Status
    • (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) --
  • NextToken (string) -- Token for the next set of results.
  • MaxResults (integer) -- Maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Grants': [
        {
            'GrantArn': 'string',
            'GrantName': 'string',
            'ParentArn': 'string',
            'LicenseArn': 'string',
            'GranteePrincipalArn': 'string',
            'HomeRegion': 'string',
            'GrantStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
            'StatusReason': 'string',
            'Version': 'string',
            'GrantedOperations': [
                'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Grants (list) --

      Received grant details.

      • (dict) --

        Describes a grant.

        • GrantArn (string) --

          Amazon Resource Name (ARN) of the grant.

        • GrantName (string) --

          Grant name.

        • ParentArn (string) --

          Parent ARN.

        • LicenseArn (string) --

          License ARN.

        • GranteePrincipalArn (string) --

          The grantee principal ARN.

        • HomeRegion (string) --

          Home Region of the grant.

        • GrantStatus (string) --

          Grant status.

        • StatusReason (string) --

          Grant status reason.

        • Version (string) --

          Grant version.

        • GrantedOperations (list) --

          Granted operations.

          • (string) --
    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_received_licenses(**kwargs)

Lists received licenses.

See also: AWS API Documentation

Request Syntax

response = client.list_received_licenses(
    LicenseArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • LicenseArns (list) --

    Amazon Resource Names (ARNs) of the licenses.

    • (string) --
  • Filters (list) --

    Filters to scope the results. The following filters are supported:

    • ProductSKU
    • Status
    • KeyFingerprint
    • Issuer
    • (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) --
  • NextToken (string) -- Token for the next set of results.
  • MaxResults (integer) -- Maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Licenses': [
        {
            'LicenseArn': 'string',
            'LicenseName': 'string',
            'ProductName': 'string',
            'ProductSKU': 'string',
            'Issuer': {
                'Name': 'string',
                'SignKey': 'string',
                'KeyFingerprint': 'string'
            },
            'HomeRegion': 'string',
            'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
            'Validity': {
                'Begin': 'string',
                'End': 'string'
            },
            'Beneficiary': 'string',
            'Entitlements': [
                {
                    'Name': 'string',
                    'Value': 'string',
                    'MaxCount': 123,
                    'Overage': True|False,
                    'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second',
                    'AllowCheckIn': True|False
                },
            ],
            'ConsumptionConfiguration': {
                'RenewType': 'None'|'Weekly'|'Monthly',
                'ProvisionalConfiguration': {
                    'MaxTimeToLiveInMinutes': 123
                },
                'BorrowConfiguration': {
                    'AllowEarlyCheckIn': True|False,
                    'MaxTimeToLiveInMinutes': 123
                }
            },
            'LicenseMetadata': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'CreateTime': 'string',
            'Version': 'string',
            'ReceivedMetadata': {
                'ReceivedStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'DISABLED',
                'AllowedOperations': [
                    'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Licenses (list) --

      Received license details.

      • (dict) --

        Describes a license that is granted to a grantee.

        • LicenseArn (string) --

          Amazon Resource Name (ARN) of the license.

        • LicenseName (string) --

          License name.

        • ProductName (string) --

          Product name.

        • ProductSKU (string) --

          Product SKU.

        • Issuer (dict) --

          Granted license issuer.

          • Name (string) --

            Issuer name.

          • SignKey (string) --

            Asymmetric CMK from AWS Key Management Service. The CMK must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

          • KeyFingerprint (string) --

            Issuer key fingerprint.

        • HomeRegion (string) --

          Home Region of the granted license.

        • Status (string) --

          Granted license status.

        • Validity (dict) --

          Date and time range during which the granted license is valid, in ISO8601-UTC format.

          • Begin (string) --

            Start of the time range.

          • End (string) --

            End of the time range.

        • Beneficiary (string) --

          Granted license beneficiary.

        • Entitlements (list) --

          License entitlements.

          • (dict) --

            Describes a resource entitled for use with a license.

            • Name (string) --

              Entitlement name.

            • Value (string) --

              Entitlement resource. Use only if the unit is None.

            • MaxCount (integer) --

              Maximum entitlement count. Use if the unit is not None.

            • Overage (boolean) --

              Indicates whether overages are allowed.

            • Unit (string) --

              Entitlement unit.

            • AllowCheckIn (boolean) --

              Indicates whether check-ins are allowed.

        • ConsumptionConfiguration (dict) --

          Configuration for consumption of the license.

          • RenewType (string) --

            Renewal frequency.

          • ProvisionalConfiguration (dict) --

            Details about a provisional configuration.

            • MaxTimeToLiveInMinutes (integer) --

              Maximum time for the provisional configuration, in minutes.

          • BorrowConfiguration (dict) --

            Details about a borrow configuration.

            • AllowEarlyCheckIn (boolean) --

              Indicates whether early check-ins are allowed.

            • MaxTimeToLiveInMinutes (integer) --

              Maximum time for the borrow configuration, in minutes.

        • LicenseMetadata (list) --

          Granted license metadata.

          • (dict) --

            Describes key/value pairs.

            • Name (string) --

              The key name.

            • Value (string) --

              The value.

        • CreateTime (string) --

          Creation time of the granted license.

        • Version (string) --

          Version of the granted license.

        • ReceivedMetadata (dict) --

          Granted license received metadata.

          • ReceivedStatus (string) --

            Received status.

          • AllowedOperations (list) --

            Allowed operations.

            • (string) --
    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_resource_inventory(**kwargs)

Lists resources managed using Systems Manager inventory.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_inventory(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Condition': 'EQUALS'|'NOT_EQUALS'|'BEGINS_WITH'|'CONTAINS',
            'Value': 'string'
        },
    ]
)
Parameters
  • MaxResults (integer) -- Maximum number of results to return in a single call.
  • NextToken (string) -- Token for the next set of results.
  • Filters (list) --

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

Return type

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.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags for the specified license configuration.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      Information about the tags.

      • (dict) --

        Details about a tag for a license configuration.

        • Key (string) --

          Tag key.

        • Value (string) --

          Tag value.

Exceptions

list_tokens(**kwargs)

Lists your tokens.

See also: AWS API Documentation

Request Syntax

response = client.list_tokens(
    TokenIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • TokenIds (list) --

    Token IDs.

    • (string) --
  • Filters (list) --

    Filters to scope the results. The following filter is supported:

    • licenseArns
    • (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) --
  • NextToken (string) -- Token for the next set of results.
  • MaxResults (integer) -- Maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Tokens': [
        {
            'TokenId': 'string',
            'TokenType': 'string',
            'LicenseArn': 'string',
            'ExpirationTime': 'string',
            'TokenProperties': [
                'string',
            ],
            'RoleArns': [
                'string',
            ],
            'Status': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Tokens (list) --

      Received token details.

      • (dict) --

        Describes a token.

        • TokenId (string) --

          Token ID.

        • TokenType (string) --

          Type of token generated. The supported value is REFRESH_TOKEN .

        • LicenseArn (string) --

          Amazon Resource Name (ARN) of the license.

        • ExpirationTime (string) --

          Token expiration time, in ISO8601-UTC format.

        • TokenProperties (list) --

          Data specified by the caller.

          • (string) --
        • RoleArns (list) --

          Amazon Resource Names (ARN) of the roles included in the token.

          • (string) --
        • Status (string) --

          Token status. The possible values are AVAILABLE and DELETED .

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_usage_for_license_configuration(**kwargs)

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

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

    [REQUIRED]

    Amazon Resource Name (ARN) of the license configuration.

  • MaxResults (integer) -- Maximum number of results to return in a single call.
  • NextToken (string) -- Token for the next set of results.
  • Filters (list) --

    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) --
Return type

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.

Exceptions

reject_grant(**kwargs)

Rejects the specified grant.

See also: AWS API Documentation

Request Syntax

response = client.reject_grant(
    GrantArn='string'
)
Parameters
GrantArn (string) --

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

Return type
dict
Returns
Response Syntax
{
    'GrantArn': 'string',
    'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
    'Version': 'string'
}

Response Structure

  • (dict) --
    • GrantArn (string) --

      Grant ARN.

    • Status (string) --

      Grant status.

    • Version (string) --

      Grant version.

Exceptions

tag_resource(**kwargs)

Adds the specified tags to the specified license configuration.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license configuration.

  • Tags (list) --

    [REQUIRED]

    One or more tags.

    • (dict) --

      Details about a tag for a license configuration.

      • Key (string) --

        Tag key.

      • Value (string) --

        Tag value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes the specified tags from the specified license configuration.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license configuration.

  • TagKeys (list) --

    [REQUIRED]

    Keys identifying the tags to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_license_configuration(**kwargs)

Modifies the attributes of an existing license configuration.

See also: AWS API Documentation

Request Syntax

response = 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
)
Parameters
  • LicenseConfigurationArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license configuration.

  • LicenseConfigurationStatus (string) -- New status of the license configuration.
  • LicenseRules (list) --

    New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

    • (string) --
  • LicenseCount (integer) -- New number of licenses managed by the license configuration.
  • LicenseCountHardLimit (boolean) -- New hard limit of the number of available licenses.
  • Name (string) -- New name of the license configuration.
  • Description (string) -- New description of the license configuration.
  • ProductInformationList (list) --

    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]

        Product information filters.

        The following filters and logical operators 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 .
        • 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) -- [REQUIRED]

            Filter name.

          • ProductInformationFilterValue (list) -- [REQUIRED]

            Filter value.

            • (string) --
          • ProductInformationFilterComparator (string) -- [REQUIRED]

            Logical operator.

  • DisassociateWhenNotFound (boolean) -- When true, disassociates a resource when software is uninstalled.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_license_specifications_for_resource(**kwargs)

Adds or removes the specified license configurations for the specified AWS resource.

You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.

See also: AWS API Documentation

Request Syntax

response = client.update_license_specifications_for_resource(
    ResourceArn='string',
    AddLicenseSpecifications=[
        {
            'LicenseConfigurationArn': 'string',
            'AmiAssociationScope': 'string'
        },
    ],
    RemoveLicenseSpecifications=[
        {
            'LicenseConfigurationArn': 'string',
            'AmiAssociationScope': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the AWS resource.

  • AddLicenseSpecifications (list) --

    ARNs of the license configurations to add.

    • (dict) --

      Details for associating a license configuration with a resource.

      • LicenseConfigurationArn (string) -- [REQUIRED]

        Amazon Resource Name (ARN) of the license configuration.

      • AmiAssociationScope (string) --

        Scope of AMI associations. The possible value is cross-account .

  • RemoveLicenseSpecifications (list) --

    ARNs of the license configurations to remove.

    • (dict) --

      Details for associating a license configuration with a resource.

      • LicenseConfigurationArn (string) -- [REQUIRED]

        Amazon Resource Name (ARN) of the license configuration.

      • AmiAssociationScope (string) --

        Scope of AMI associations. The possible value is cross-account .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_service_settings(**kwargs)

Updates License Manager settings for the current Region.

See also: AWS API Documentation

Request Syntax

response = client.update_service_settings(
    S3BucketArn='string',
    SnsTopicArn='string',
    OrganizationConfiguration={
        'EnableIntegration': True|False
    },
    EnableCrossAccountsDiscovery=True|False
)
Parameters
  • S3BucketArn (string) -- Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.
  • SnsTopicArn (string) -- Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.
  • OrganizationConfiguration (dict) --

    Enables integration with AWS Organizations for cross-account discovery.

    • EnableIntegration (boolean) -- [REQUIRED]

      Enables AWS Organization integration.

  • EnableCrossAccountsDiscovery (boolean) -- Activates cross-account discovery.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class LicenseManager.Client.exceptions.AccessDeniedException

Access to resource denied.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Access to resource denied.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.

Example

try:
  ...
except client.exceptions.AuthorizationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.ConflictException

There was a conflict processing the request. Try your request again.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There was a conflict processing the request. Try your request again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.EntitlementNotAllowedException

The entitlement is not allowed.

Example

try:
  ...
except client.exceptions.EntitlementNotAllowedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The entitlement is not allowed.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.FailedDependencyException

A dependency required to run the API is missing.

Example

try:
  ...
except client.exceptions.FailedDependencyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ErrorCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A dependency required to run the API is missing.

    • Message (string) --
    • ErrorCode (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.FilterLimitExceededException

The request uses too many filters or too many filter values.

Example

try:
  ...
except client.exceptions.FilterLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request uses too many filters or too many filter values.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.InvalidParameterValueException

One or more parameter values are not valid.

Example

try:
  ...
except client.exceptions.InvalidParameterValueException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One or more parameter values are not valid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.InvalidResourceStateException

License Manager cannot allocate a license to a resource because of its state.

For example, you cannot allocate a license to an instance in the process of shutting down.

Example

try:
  ...
except client.exceptions.InvalidResourceStateException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    License Manager cannot allocate a license to a resource because of its state.

    For example, you cannot allocate a license to an instance in the process of shutting down.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.LicenseUsageException

You do not have enough licenses available to support a new resource launch.

Example

try:
  ...
except client.exceptions.LicenseUsageException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have enough licenses available to support a new resource launch.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.NoEntitlementsAllowedException

There are no entitlements found for this license, or the entitlement maximum count is reached.

Example

try:
  ...
except client.exceptions.NoEntitlementsAllowedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There are no entitlements found for this license, or the entitlement maximum count is reached.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

Example

try:
  ...
except client.exceptions.RateLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Too many requests have been submitted. Try again after a brief wait.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.RedirectException

This is not the correct Region for the resource. Try again.

Example

try:
  ...
except client.exceptions.RedirectException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Location': 'string',
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    This is not the correct Region for the resource. Try again.

    • Location (string) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.ResourceLimitExceededException

Your resource limits have been exceeded.

Example

try:
  ...
except client.exceptions.ResourceLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Your resource limits have been exceeded.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.ResourceNotFoundException

The resource cannot be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource cannot be found.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.ServerInternalException

The server experienced an internal error. Try again.

Example

try:
  ...
except client.exceptions.ServerInternalException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The server experienced an internal error. Try again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.UnsupportedDigitalSignatureMethodException

The digital signature method is unsupported. Try your request again.

Example

try:
  ...
except client.exceptions.UnsupportedDigitalSignatureMethodException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The digital signature method is unsupported. Try your request again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManager.Client.exceptions.ValidationException

The provided input is not valid. Try your request again.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The provided input is not valid. Try your request again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class LicenseManager.Paginator.ListAssociationsForLicenseConfiguration
paginator = client.get_paginator('list_associations_for_license_configuration')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LicenseManager.Client.list_associations_for_license_configuration().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    LicenseConfigurationArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • LicenseConfigurationArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of a license configuration.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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),
            'AmiAssociationScope': '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.

        • AmiAssociationScope (string) --

          Scope of AMI associations. The possible value is cross-account .

class LicenseManager.Paginator.ListLicenseConfigurations
paginator = client.get_paginator('list_license_configurations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LicenseManager.Client.list_license_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    LicenseConfigurationArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • LicenseConfigurationArns (list) --

    Amazon Resource Names (ARN) of the license configurations.

    • (string) --
  • Filters (list) --

    Filters to scope the results. The following filters and logical operators are supported:

    • licenseCountingType - The dimension on which licenses are counted. Possible values are vCPU | Instance | Core | Socket . 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) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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

}

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

              Product information filters.

              The following filters and logical operators 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 .
              • 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.

class LicenseManager.Paginator.ListLicenseSpecificationsForResource
paginator = client.get_paginator('list_license_specifications_for_resource')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LicenseManager.Client.list_license_specifications_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of a resource that has an associated license configuration.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'LicenseSpecifications': [
        {
            'LicenseConfigurationArn': 'string',
            'AmiAssociationScope': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • LicenseSpecifications (list) --

      License configurations associated with a resource.

      • (dict) --

        Details for associating a license configuration with a resource.

        • LicenseConfigurationArn (string) --

          Amazon Resource Name (ARN) of the license configuration.

        • AmiAssociationScope (string) --

          Scope of AMI associations. The possible value is cross-account .

class LicenseManager.Paginator.ListResourceInventory
paginator = client.get_paginator('list_resource_inventory')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LicenseManager.Client.list_resource_inventory().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Condition': 'EQUALS'|'NOT_EQUALS'|'BEGINS_WITH'|'CONTAINS',
            'Value': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

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

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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

}

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.

class LicenseManager.Paginator.ListUsageForLicenseConfiguration
paginator = client.get_paginator('list_usage_for_license_configuration')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LicenseManager.Client.list_usage_for_license_configuration().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    LicenseConfigurationArn='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • LicenseConfigurationArn (string) --

    [REQUIRED]

    Amazon Resource Name (ARN) of the license configuration.

  • Filters (list) --

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

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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
        },
    ],

}

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.