Table of Contents
LicenseManager.Client¶A low-level client representing AWS License Manager
License Manager makes it easier to manage licenses from software vendors across multiple Amazon Web Services accounts and on-premises servers.
import boto3
client = boto3.client('license-manager')
These are the available methods:
accept_grant()can_paginate()check_in_license()checkout_borrow_license()checkout_license()close()create_grant()create_grant_version()create_license()create_license_configuration()create_license_conversion_task_for_resource()create_license_manager_report_generator()create_license_version()create_token()delete_grant()delete_license()delete_license_configuration()delete_license_manager_report_generator()delete_token()extend_license_consumption()get_access_token()get_grant()get_license()get_license_configuration()get_license_conversion_task()get_license_manager_report_generator()get_license_usage()get_paginator()get_service_settings()get_waiter()list_associations_for_license_configuration()list_distributed_grants()list_failures_for_license_configuration_operations()list_license_configurations()list_license_conversion_tasks()list_license_manager_report_generators()list_license_specifications_for_resource()list_license_versions()list_licenses()list_received_grants()list_received_grants_for_organization()list_received_licenses()list_received_licenses_for_organization()list_resource_inventory()list_tags_for_resource()list_tokens()list_usage_for_license_configuration()reject_grant()tag_resource()untag_resource()update_license_configuration()update_license_manager_report_generator()update_license_specifications_for_resource()update_service_settings()accept_grant(**kwargs)¶Accepts the specified grant.
See also: AWS API Documentation
Request Syntax
response = client.accept_grant(
GrantArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the grant.
{
'GrantArn': 'string',
'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED',
'Version': 'string'
}
Response Structure
Grant ARN.
Grant status.
Grant version.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").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'
)
[REQUIRED]
License consumption token.
dict
Response Syntax
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionLicenseManager.Client.exceptions.ConflictExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptioncheckout_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'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.
[REQUIRED]
License entitlements. Partial checkouts are not supported.
Data associated with an entitlement resource.
Entitlement data name.
Entitlement data value.
Entitlement data unit.
[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.
Information about constraints.
Describes key/value pairs.
The key name.
The value.
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
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
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionLicenseManager.Client.exceptions.NoEntitlementsAllowedExceptionLicenseManager.Client.exceptions.EntitlementNotAllowedExceptionLicenseManager.Client.exceptions.UnsupportedDigitalSignatureMethodExceptionLicenseManager.Client.exceptions.RedirectExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptioncheckout_license(**kwargs)¶Checks out the specified license.
Note
If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.
See also: AWS API Documentation
Request Syntax
response = client.checkout_license(
ProductSKU='string',
CheckoutType='PROVISIONAL'|'PERPETUAL',
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'
)
[REQUIRED]
Product SKU.
[REQUIRED]
Checkout type.
[REQUIRED]
Key fingerprint identifying the license.
[REQUIRED]
License entitlements.
Data associated with an entitlement resource.
Entitlement data name.
Entitlement data value.
Entitlement data unit.
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
Response Syntax
{
'CheckoutType': 'PROVISIONAL'|'PERPETUAL',
'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',
'LicenseArn': '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.
LicenseArn (string) --
Amazon Resource Name (ARN) of the checkout license.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionLicenseManager.Client.exceptions.NoEntitlementsAllowedExceptionLicenseManager.Client.exceptions.UnsupportedDigitalSignatureMethodExceptionLicenseManager.Client.exceptions.RedirectExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionclose()¶Closes underlying endpoint connections.
create_grant(**kwargs)¶Creates a grant for the specified license. A grant shares the use of license entitlements with specific Amazon Web Services 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',
]
)
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
[REQUIRED]
Grant name.
[REQUIRED]
Amazon Resource Name (ARN) of the license.
[REQUIRED]
The grant principals. This value should be specified as an Amazon Resource Name (ARN).
[REQUIRED]
Home Region of the grant.
[REQUIRED]
Allowed operations for the grant.
dict
Response Syntax
{
'GrantArn': 'string',
'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED',
'Version': 'string'
}
Response Structure
(dict) --
GrantArn (string) --
Grant ARN.
Status (string) --
Grant status.
Version (string) --
Grant version.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.AccessDeniedExceptioncreate_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'|'WORKFLOW_COMPLETED',
StatusReason='string',
SourceVersion='string'
)
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
[REQUIRED]
Amazon Resource Name (ARN) of the grant.
Allowed operations for the grant.
dict
Response Syntax
{
'GrantArn': 'string',
'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED',
'Version': 'string'
}
Response Structure
(dict) --
GrantArn (string) --
Grant ARN.
Status (string) --
Grant status.
Version (string) --
New version of the grant.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptioncreate_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'
)
[REQUIRED]
License name.
[REQUIRED]
Product name.
[REQUIRED]
Product SKU.
[REQUIRED]
License issuer.
Issuer name.
Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
[REQUIRED]
Home Region for the license.
[REQUIRED]
Date and time range during which the license is valid, in ISO8601-UTC format.
Start of the time range.
End of the time range.
[REQUIRED]
License entitlements.
Describes a resource entitled for use with a license.
Entitlement name.
Entitlement resource. Use only if the unit is None.
Maximum entitlement count. Use if the unit is not None.
Indicates whether overages are allowed.
Entitlement unit.
Indicates whether check-ins are allowed.
[REQUIRED]
License beneficiary.
[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.
Renewal frequency.
Details about a provisional configuration.
Maximum time for the provisional configuration, in minutes.
Details about a borrow configuration.
Indicates whether early check-ins are allowed.
Maximum time for the borrow configuration, in minutes.
Information about the license.
Describes key/value pairs.
The key name.
The value.
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
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
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.RedirectExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptioncreate_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'
},
]
},
]
)
[REQUIRED]
Name of the license configuration.
[REQUIRED]
Dimension used to track the license inventory.
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 | minimumCoresInstances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpusSockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSocketsvCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpusThe 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 .
Tags to add to the license configuration.
Details about a tag for a license configuration.
Tag key.
Tag value.
Product information.
Describes product information for a license configuration.
Resource type. The possible values are SSM_MANAGED | RDS .
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator .
The following filters and are supported when the resource type is SSM_MANAGED :
Application Name - The name of the application. Logical operator is EQUALS .Application Publisher - The publisher of the application. Logical operator is EQUALS .Application Version - The version of the application. Logical operator is EQUALS .Platform Name - The name of the platform. Logical operator is EQUALS .Platform Type - The platform type. Logical operator is EQUALS .Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key . ProductInformationFilterValue is optional if you are not using values for the key.AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS .License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .The following filters and logical operators are supported when the resource type is RDS :
Engine Edition - The edition of the database engine. Logical operator is EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 .License Pack - The license pack. Logical operator is EQUALS . Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap .Describes product information filters.
Filter name.
Filter value.
Logical operator.
dict
Response Syntax
{
'LicenseConfigurationArn': 'string'
}
Response Structure
(dict) --
LicenseConfigurationArn (string) --
Amazon Resource Name (ARN) of the license configuration.
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptioncreate_license_conversion_task_for_resource(**kwargs)¶Creates a new license conversion task.
See also: AWS API Documentation
Request Syntax
response = client.create_license_conversion_task_for_resource(
ResourceArn='string',
SourceLicenseContext={
'UsageOperation': 'string'
},
DestinationLicenseContext={
'UsageOperation': 'string'
}
)
[REQUIRED]
Amazon Resource Name (ARN) of the resource you are converting the license type for.
[REQUIRED]
Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide .
The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
[REQUIRED]
Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide .
The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
dict
Response Syntax
{
'LicenseConversionTaskId': 'string'
}
Response Structure
(dict) --
LicenseConversionTaskId (string) --
The ID of the created license type conversion task.
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptioncreate_license_manager_report_generator(**kwargs)¶Creates a report generator.
See also: AWS API Documentation
Request Syntax
response = client.create_license_manager_report_generator(
ReportGeneratorName='string',
Type=[
'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport',
],
ReportContext={
'licenseConfigurationArns': [
'string',
]
},
ReportFrequency={
'value': 123,
'period': 'DAY'|'WEEK'|'MONTH'
},
ClientToken='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Name of the report generator.
[REQUIRED]
Type of reports to generate. The following report types an be generated:
[REQUIRED]
Defines the type of license configuration the report generator tracks.
Amazon Resource Name (ARN) of the license configuration that this generator reports on.
[REQUIRED]
Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.
Number of times within the frequency period that a report is generated. The only supported value is 1 .
Time period between each report. The period can be daily, weekly, or monthly.
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Tags to add to the report generator.
Details about a tag for a license configuration.
Tag key.
Tag value.
dict
Response Syntax
{
'LicenseManagerReportGeneratorArn': 'string'
}
Response Structure
(dict) --
LicenseManagerReportGeneratorArn (string) --
The Amazon Resource Name (ARN) of the new report generator.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptioncreate_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'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license.
[REQUIRED]
License name.
[REQUIRED]
Product name.
[REQUIRED]
License issuer.
Issuer name.
Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
[REQUIRED]
Home Region of the license.
[REQUIRED]
Date and time range during which the license is valid, in ISO8601-UTC format.
Start of the time range.
End of the time range.
Information about the license.
Describes key/value pairs.
The key name.
The value.
[REQUIRED]
License entitlements.
Describes a resource entitled for use with a license.
Entitlement name.
Entitlement resource. Use only if the unit is None.
Maximum entitlement count. Use if the unit is not None.
Indicates whether overages are allowed.
Entitlement unit.
Indicates whether check-ins are allowed.
[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.
Renewal frequency.
Details about a provisional configuration.
Maximum time for the provisional configuration, in minutes.
Details about a borrow configuration.
Indicates whether early check-ins are allowed.
Maximum time for the borrow configuration, in minutes.
[REQUIRED]
License status.
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
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
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionLicenseManager.Client.exceptions.RedirectExceptionLicenseManager.Client.exceptions.ConflictExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptioncreate_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'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.
Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.
Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.
[REQUIRED]
Idempotency token, valid for 10 minutes.
dict
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
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionLicenseManager.Client.exceptions.RedirectExceptiondelete_grant(**kwargs)¶Deletes the specified grant.
See also: AWS API Documentation
Request Syntax
response = client.delete_grant(
GrantArn='string',
StatusReason='string',
Version='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the grant.
[REQUIRED]
Current version of the grant.
dict
Response Syntax
{
'GrantArn': 'string',
'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED',
'Version': 'string'
}
Response Structure
(dict) --
GrantArn (string) --
Grant ARN.
Status (string) --
Grant status.
Version (string) --
Grant version.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptiondelete_license(**kwargs)¶Deletes the specified license.
See also: AWS API Documentation
Request Syntax
response = client.delete_license(
LicenseArn='string',
SourceVersion='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license.
[REQUIRED]
Current version of the license.
dict
Response Syntax
{
'Status': 'PENDING_DELETE'|'DELETED',
'DeletionDate': 'string'
}
Response Structure
(dict) --
Status (string) --
License status.
DeletionDate (string) --
Date when the license is deleted.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.RedirectExceptionLicenseManager.Client.exceptions.ConflictExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptiondelete_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'
)
[REQUIRED]
ID of the license configuration.
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptiondelete_license_manager_report_generator(**kwargs)¶Deletes the specified report generator.
This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.
See also: AWS API Documentation
Request Syntax
response = client.delete_license_manager_report_generator(
LicenseManagerReportGeneratorArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the report generator to be deleted.
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptiondelete_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'
)
[REQUIRED]
Token ID.
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionLicenseManager.Client.exceptions.RedirectExceptionextend_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
)
[REQUIRED]
License consumption token.
dict
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
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionget_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',
]
)
[REQUIRED]
Refresh token, encoded as a JWT token.
Token properties to validate against those present in the JWT token.
dict
Response Syntax
{
'AccessToken': 'string'
}
Response Structure
(dict) --
AccessToken (string) --
Temporary access token.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionget_grant(**kwargs)¶Gets detailed information about the specified grant.
See also: AWS API Documentation
Request Syntax
response = client.get_grant(
GrantArn='string',
Version='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the grant.
dict
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'|'WORKFLOW_COMPLETED',
'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.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionget_license(**kwargs)¶Gets detailed information about the specified license.
See also: AWS API Documentation
Request Syntax
response = client.get_license(
LicenseArn='string',
Version='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license.
dict
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 KMS key from Key Management Service. The KMS key 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
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionget_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'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
{
'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
Unique ID for the license configuration.
Amazon Resource Name (ARN) of the license configuration.
Name of the license configuration.
Description of the license configuration.
Dimension for which the licenses are counted.
License rules.
Number of available licenses.
Sets the number of available licenses as a hard limit.
Number of licenses assigned to resources.
License configuration status.
Account ID of the owner of the license configuration.
Summaries of the licenses consumed by resources.
Details about license consumption.
Resource type of the resource consuming a license.
Number of licenses consumed by the resource.
Summaries of the managed resources.
Summary information about a managed resource.
Type of resource associated with a license.
Number of resources associated with licenses.
Tags for the license configuration.
Details about a tag for a license configuration.
Tag key.
Tag value.
Product information.
Describes product information for a license configuration.
Resource type. The possible values are SSM_MANAGED | RDS .
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator .
The following filters and are supported when the resource type is SSM_MANAGED :
Application Name - The name of the application. Logical operator is EQUALS .Application Publisher - The publisher of the application. Logical operator is EQUALS .Application Version - The version of the application. Logical operator is EQUALS .Platform Name - The name of the platform. Logical operator is EQUALS .Platform Type - The platform type. Logical operator is EQUALS .Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key . ProductInformationFilterValue is optional if you are not using values for the key.AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS .License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .The following filters and logical operators are supported when the resource type is RDS :
Engine Edition - The edition of the database engine. Logical operator is EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 .License Pack - The license pack. Logical operator is EQUALS . Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap .Describes product information filters.
Filter name.
Filter value.
Logical operator.
Automated discovery information.
Time that automated discovery last ran.
When true, disassociates a resource when software is uninstalled.
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionget_license_conversion_task(**kwargs)¶Gets information about the specified license type conversion task.
See also: AWS API Documentation
Request Syntax
response = client.get_license_conversion_task(
LicenseConversionTaskId='string'
)
[REQUIRED]
ID of the license type conversion task to retrieve information on.
{
'LicenseConversionTaskId': 'string',
'ResourceArn': 'string',
'SourceLicenseContext': {
'UsageOperation': 'string'
},
'DestinationLicenseContext': {
'UsageOperation': 'string'
},
'StatusMessage': 'string',
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'StartTime': datetime(2015, 1, 1),
'LicenseConversionTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
Response Structure
ID of the license type conversion task.
Amazon Resource Names (ARN) of the resources the license conversion task is associated with.
Information about the license type converted from.
The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
Information about the license type converted to.
The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
The status message for the conversion task.
Status of the license type conversion task.
Time at which the license type conversion task was started .
Amount of time to complete the license type conversion.
Time at which the license type conversion task was completed.
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionget_license_manager_report_generator(**kwargs)¶Gets information about the specified report generator.
See also: AWS API Documentation
Request Syntax
response = client.get_license_manager_report_generator(
LicenseManagerReportGeneratorArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the report generator.
{
'ReportGenerator': {
'ReportGeneratorName': 'string',
'ReportType': [
'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport',
],
'ReportContext': {
'licenseConfigurationArns': [
'string',
]
},
'ReportFrequency': {
'value': 123,
'period': 'DAY'|'WEEK'|'MONTH'
},
'LicenseManagerReportGeneratorArn': 'string',
'LastRunStatus': 'string',
'LastRunFailureReason': 'string',
'LastReportGenerationTime': 'string',
'ReportCreatorAccount': 'string',
'Description': 'string',
'S3Location': {
'bucket': 'string',
'keyPrefix': 'string'
},
'CreateTime': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
A report generator that creates periodic reports about your license configurations.
Name of the report generator.
Type of reports that are generated.
License configuration type for this generator.
Amazon Resource Name (ARN) of the license configuration that this generator reports on.
Details about how frequently reports are generated.
Number of times within the frequency period that a report is generated. The only supported value is 1 .
Time period between each report. The period can be daily, weekly, or monthly.
Amazon Resource Name (ARN) of the report generator.
Status of the last report generation attempt.
Failure message for the last report generation attempt.
Time the last report was generated at.
The Amazon Web Services account ID used to create the report generator.
Description of the report generator.
Details of the S3 bucket that report generator reports are published to.
Name of the S3 bucket reports are published to.
Prefix of the S3 bucket reports are published to.
Time the report was created.
Tags associated with the report generator.
Details about a tag for a license configuration.
Tag key.
Tag value.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionget_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'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license.
{
'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
License usage details.
License entitlement usages.
Usage associated with an entitlement resource.
Entitlement usage name.
Resource usage consumed.
Maximum entitlement usage count.
Entitlement usage unit.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_service_settings()¶Gets the License Manager settings for the current Region.
See also: AWS API Documentation
Request Syntax
response = client.get_service_settings()
{
'S3BucketArn': 'string',
'SnsTopicArn': 'string',
'OrganizationConfiguration': {
'EnableIntegration': True|False
},
'EnableCrossAccountsDiscovery': True|False,
'LicenseManagerResourceShareArn': 'string'
}
Response Structure
Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
SNS topic configured to receive notifications from License Manager.
Indicates whether Organizations is integrated with License Manager for cross-account discovery.
Enables Organizations integration.
Indicates whether cross-account discovery is enabled.
Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.
Exceptions
LicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
[REQUIRED]
Amazon Resource Name (ARN) of a license configuration.
dict
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 Amazon Web Services 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
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.FilterLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_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
)
Amazon Resource Names (ARNs) of the grants.
Filters to scope the results. The following filters are supported:
LicenseArnGrantStatusGranteePrincipalARNProductSKULicenseIssuerNameA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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'|'WORKFLOW_COMPLETED',
'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.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_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'
)
[REQUIRED]
Amazon Resource Name of the license configuration.
dict
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 Amazon Web Services 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
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_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',
]
},
]
)
Amazon Resource Names (ARN) of the license configurations.
Filters to scope the results. The following filters and logical operators are supported:
licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket . 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 .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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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.
LicenseCount (integer) --
Number of licenses managed by the license configuration.
LicenseCountHardLimit (boolean) --
Number of available licenses as a hard limit.
DisassociateWhenNotFound (boolean) --
When true, disassociates a resource when software is uninstalled.
ConsumedLicenses (integer) --
Number of licenses consumed.
Status (string) --
Status of the license configuration.
OwnerAccountId (string) --
Account ID of the license configuration's owner.
ConsumedLicenseSummaryList (list) --
Summaries for licenses consumed by various resources.
(dict) --
Details about license consumption.
ResourceType (string) --
Resource type of the resource consuming a license.
ConsumedLicenses (integer) --
Number of licenses consumed by the resource.
ManagedResourceSummaryList (list) --
Summaries for managed resources.
(dict) --
Summary information about a managed resource.
ResourceType (string) --
Type of resource associated with a license.
AssociationCount (integer) --
Number of resources associated with licenses.
ProductInformationList (list) --
Product information.
(dict) --
Describes product information for a license configuration.
ResourceType (string) --
Resource type. The possible values are SSM_MANAGED | RDS .
ProductInformationFilterList (list) --
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator .
The following filters and are supported when the resource type is SSM_MANAGED :
Application Name - The name of the application. Logical operator is EQUALS .Application Publisher - The publisher of the application. Logical operator is EQUALS .Application Version - The version of the application. Logical operator is EQUALS .Platform Name - The name of the platform. Logical operator is EQUALS .Platform Type - The platform type. Logical operator is EQUALS .Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key . ProductInformationFilterValue is optional if you are not using values for the key.AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS .License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .The following filters and logical operators are supported when the resource type is RDS :
Engine Edition - The edition of the database engine. Logical operator is EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 .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.
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
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.FilterLimitExceededExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_license_conversion_tasks(**kwargs)¶Lists the license type conversion tasks for your account.
See also: AWS API Documentation
Request Syntax
response = client.list_license_conversion_tasks(
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
Filters to scope the results. Valid filters are ResourceArns and Status .
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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LicenseConversionTasks': [
{
'LicenseConversionTaskId': 'string',
'ResourceArn': 'string',
'SourceLicenseContext': {
'UsageOperation': 'string'
},
'DestinationLicenseContext': {
'UsageOperation': 'string'
},
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'StartTime': datetime(2015, 1, 1),
'LicenseConversionTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LicenseConversionTasks (list) --
Information about the license configuration tasks for your account.
(dict) --
Information about a license type conversion task.
LicenseConversionTaskId (string) --
The ID of the license type conversion task.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.
SourceLicenseContext (dict) --
Information about the license type this conversion task converted from.
UsageOperation (string) --
The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
DestinationLicenseContext (dict) --
Information about the license type this conversion task converted to.
UsageOperation (string) --
The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
Status (string) --
The status of the conversion task.
StatusMessage (string) --
The status message for the conversion task.
StartTime (datetime) --
The time the conversion task was started at.
LicenseConversionTime (datetime) --
The time the usage operation value of the resource was changed.
EndTime (datetime) --
The time the conversion task was completed.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_license_manager_report_generators(**kwargs)¶Lists the report generators for your account.
See also: AWS API Documentation
Request Syntax
response = client.list_license_manager_report_generators(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
Filters to scope the results. The following filters are supported:
LicenseConfigurationArnA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ReportGenerators': [
{
'ReportGeneratorName': 'string',
'ReportType': [
'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport',
],
'ReportContext': {
'licenseConfigurationArns': [
'string',
]
},
'ReportFrequency': {
'value': 123,
'period': 'DAY'|'WEEK'|'MONTH'
},
'LicenseManagerReportGeneratorArn': 'string',
'LastRunStatus': 'string',
'LastRunFailureReason': 'string',
'LastReportGenerationTime': 'string',
'ReportCreatorAccount': 'string',
'Description': 'string',
'S3Location': {
'bucket': 'string',
'keyPrefix': 'string'
},
'CreateTime': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReportGenerators (list) --
A report generator that creates periodic reports about your license configurations.
(dict) --
Describe the details of a report generator.
ReportGeneratorName (string) --
Name of the report generator.
ReportType (list) --
Type of reports that are generated.
ReportContext (dict) --
License configuration type for this generator.
licenseConfigurationArns (list) --
Amazon Resource Name (ARN) of the license configuration that this generator reports on.
ReportFrequency (dict) --
Details about how frequently reports are generated.
value (integer) --
Number of times within the frequency period that a report is generated. The only supported value is 1 .
period (string) --
Time period between each report. The period can be daily, weekly, or monthly.
LicenseManagerReportGeneratorArn (string) --
Amazon Resource Name (ARN) of the report generator.
LastRunStatus (string) --
Status of the last report generation attempt.
LastRunFailureReason (string) --
Failure message for the last report generation attempt.
LastReportGenerationTime (string) --
Time the last report was generated at.
ReportCreatorAccount (string) --
The Amazon Web Services account ID used to create the report generator.
Description (string) --
Description of the report generator.
S3Location (dict) --
Details of the S3 bucket that report generator reports are published to.
bucket (string) --
Name of the S3 bucket reports are published to.
keyPrefix (string) --
Prefix of the S3 bucket reports are published to.
CreateTime (string) --
Time the report was created.
Tags (list) --
Tags associated with the report generator.
(dict) --
Details about a tag for a license configuration.
Key (string) --
Tag key.
Value (string) --
Tag value.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionlist_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'
)
[REQUIRED]
Amazon Resource Name (ARN) of a resource that has an associated license configuration.
dict
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
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_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
)
[REQUIRED]
Amazon Resource Name (ARN) of the license.
dict
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 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 KMS key from Key Management Service. The KMS key 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
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionlist_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
)
Amazon Resource Names (ARNs) of the licenses.
Filters to scope the results. The following filters are supported:
BeneficiaryProductSKUFingerprintStatusA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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 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 KMS key from Key Management Service. The KMS key 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
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionlist_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
)
Amazon Resource Names (ARNs) of the grants.
Filters to scope the results. The following filters are supported:
ProductSKULicenseIssuerNameLicenseArnGrantStatusGranterAccountIdA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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'|'WORKFLOW_COMPLETED',
'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.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_received_grants_for_organization(**kwargs)¶Lists the grants received for all accounts in the organization.
See also: AWS API Documentation
Request Syntax
response = client.list_received_grants_for_organization(
LicenseArn='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the received license.
Filters to scope the results. The following filters are supported:
ParentArnGranteePrincipalArnA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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'|'WORKFLOW_COMPLETED',
'StatusReason': 'string',
'Version': 'string',
'GrantedOperations': [
'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Grants (list) --
Lists the grants the organization has received.
(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.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_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
)
Amazon Resource Names (ARNs) of the licenses.
Filters to scope the results. The following filters are supported:
ProductSKUStatusFingerprintIssuerNameBeneficiaryA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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'|'WORKFLOW_COMPLETED',
'ReceivedStatusReason': 'string',
'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 KMS key from Key Management Service. The KMS key 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.
ReceivedStatusReason (string) --
Received status reason.
AllowedOperations (list) --
Allowed operations.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_received_licenses_for_organization(**kwargs)¶Lists the licenses received for all accounts in the organization.
See also: AWS API Documentation
Request Syntax
response = client.list_received_licenses_for_organization(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
Filters to scope the results. The following filters are supported:
BeneficiaryProductSKUA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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'|'WORKFLOW_COMPLETED',
'ReceivedStatusReason': 'string',
'AllowedOperations': [
'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Licenses (list) --
Lists the licenses the organization has received.
(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 KMS key from Key Management Service. The KMS key 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.
ReceivedStatusReason (string) --
Received status reason.
AllowedOperations (list) --
Allowed operations.
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_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'
},
]
)
Filters to scope the results. The following filters and logical operators are supported:
account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS .application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH .license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH .resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS .tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).An inventory filter.
Name of the filter.
Condition of the filter.
Value of the filter.
dict
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
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.FilterLimitExceededExceptionLicenseManager.Client.exceptions.FailedDependencyExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLists the tags for the specified license configuration.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
Information about the tags.
Details about a tag for a license configuration.
Tag key.
Tag value.
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionlist_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
)
Token IDs.
Filters to scope the results. The following filter is supported:
LicenseArnsA 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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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.
RoleArns (list) --
Amazon Resource Names (ARN) of the roles included in the token.
Status (string) --
Token status. The possible values are AVAILABLE and DELETED .
NextToken (string) --
Token for the next set of results.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionlist_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',
]
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
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 .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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
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
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.FilterLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionreject_grant(**kwargs)¶Rejects the specified grant.
See also: AWS API Documentation
Request Syntax
response = client.reject_grant(
GrantArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the grant.
{
'GrantArn': 'string',
'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED',
'Version': 'string'
}
Response Structure
Grant ARN.
Grant status.
Grant version.
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptiontag_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'
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
[REQUIRED]
One or more tags.
Details about a tag for a license configuration.
Tag key.
Tag value.
dict
Response Syntax
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionuntag_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',
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
[REQUIRED]
Keys identifying the tags to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionupdate_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
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.
New product information.
Describes product information for a license configuration.
Resource type. The possible values are SSM_MANAGED | RDS .
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator .
The following filters and are supported when the resource type is SSM_MANAGED :
Application Name - The name of the application. Logical operator is EQUALS .Application Publisher - The publisher of the application. Logical operator is EQUALS .Application Version - The version of the application. Logical operator is EQUALS .Platform Name - The name of the platform. Logical operator is EQUALS .Platform Type - The platform type. Logical operator is EQUALS .Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key . ProductInformationFilterValue is optional if you are not using values for the key.AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS .License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .The following filters and logical operators are supported when the resource type is RDS :
Engine Edition - The edition of the database engine. Logical operator is EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 .License Pack - The license pack. Logical operator is EQUALS . Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap .Describes product information filters.
Filter name.
Filter value.
Logical operator.
dict
Response Syntax
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionupdate_license_manager_report_generator(**kwargs)¶Updates a report generator.
After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.
See also: AWS API Documentation
Request Syntax
response = client.update_license_manager_report_generator(
LicenseManagerReportGeneratorArn='string',
ReportGeneratorName='string',
Type=[
'LicenseConfigurationSummaryReport'|'LicenseConfigurationUsageReport',
],
ReportContext={
'licenseConfigurationArns': [
'string',
]
},
ReportFrequency={
'value': 123,
'period': 'DAY'|'WEEK'|'MONTH'
},
ClientToken='string',
Description='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the report generator to update.
[REQUIRED]
Name of the report generator.
[REQUIRED]
Type of reports to generate. The following report types are supported:
[REQUIRED]
The report context.
Amazon Resource Name (ARN) of the license configuration that this generator reports on.
[REQUIRED]
Frequency by which reports are generated.
Number of times within the frequency period that a report is generated. The only supported value is 1 .
Time period between each report. The period can be daily, weekly, or monthly.
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
Response Syntax
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.ValidationExceptionLicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.ResourceNotFoundExceptionLicenseManager.Client.exceptions.ResourceLimitExceededExceptionupdate_license_specifications_for_resource(**kwargs)¶Adds or removes the specified license configurations for the specified Amazon Web Services resource.
You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and 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'
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the Amazon Web Services resource.
ARNs of the license configurations to add.
Details for associating a license configuration with a resource.
Amazon Resource Name (ARN) of the license configuration.
Scope of AMI associations. The possible value is cross-account .
ARNs of the license configurations to remove.
Details for associating a license configuration with a resource.
Amazon Resource Name (ARN) of the license configuration.
Scope of AMI associations. The possible value is cross-account .
dict
Response Syntax
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.InvalidResourceStateExceptionLicenseManager.Client.exceptions.LicenseUsageExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionupdate_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
)
Enables integration with Organizations for cross-account discovery.
Enables Organizations integration.
dict
Response Syntax
{}
Response Structure
Exceptions
LicenseManager.Client.exceptions.InvalidParameterValueExceptionLicenseManager.Client.exceptions.ServerInternalExceptionLicenseManager.Client.exceptions.AuthorizationExceptionLicenseManager.Client.exceptions.AccessDeniedExceptionLicenseManager.Client.exceptions.RateLimitExceededExceptionThe available paginators are:
LicenseManager.Paginator.ListAssociationsForLicenseConfigurationLicenseManager.Paginator.ListLicenseConfigurationsLicenseManager.Paginator.ListLicenseSpecificationsForResourceLicenseManager.Paginator.ListResourceInventoryLicenseManager.Paginator.ListUsageForLicenseConfigurationLicenseManager.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'
}
)
[REQUIRED]
Amazon Resource Name (ARN) of a license configuration.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 Amazon Web Services 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 .
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'
}
)
Amazon Resource Names (ARN) of the license configurations.
Filters to scope the results. The following filters and logical operators are supported:
licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket . 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 .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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.
LicenseCount (integer) --
Number of licenses managed by the license configuration.
LicenseCountHardLimit (boolean) --
Number of available licenses as a hard limit.
DisassociateWhenNotFound (boolean) --
When true, disassociates a resource when software is uninstalled.
ConsumedLicenses (integer) --
Number of licenses consumed.
Status (string) --
Status of the license configuration.
OwnerAccountId (string) --
Account ID of the license configuration's owner.
ConsumedLicenseSummaryList (list) --
Summaries for licenses consumed by various resources.
(dict) --
Details about license consumption.
ResourceType (string) --
Resource type of the resource consuming a license.
ConsumedLicenses (integer) --
Number of licenses consumed by the resource.
ManagedResourceSummaryList (list) --
Summaries for managed resources.
(dict) --
Summary information about a managed resource.
ResourceType (string) --
Type of resource associated with a license.
AssociationCount (integer) --
Number of resources associated with licenses.
ProductInformationList (list) --
Product information.
(dict) --
Describes product information for a license configuration.
ResourceType (string) --
Resource type. The possible values are SSM_MANAGED | RDS .
ProductInformationFilterList (list) --
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator .
The following filters and are supported when the resource type is SSM_MANAGED :
Application Name - The name of the application. Logical operator is EQUALS .Application Publisher - The publisher of the application. Logical operator is EQUALS .Application Version - The version of the application. Logical operator is EQUALS .Platform Name - The name of the platform. Logical operator is EQUALS .Platform Type - The platform type. Logical operator is EQUALS .Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key . ProductInformationFilterValue is optional if you are not using values for the key.AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS .License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .The following filters and logical operators are supported when the resource type is RDS :
Engine Edition - The edition of the database engine. Logical operator is EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 .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.
ProductInformationFilterComparator (string) --
Logical operator.
AutomatedDiscoveryInformation (dict) --
Automated discovery information.
LastRunTime (datetime) --
Time that automated discovery last ran.
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'
}
)
[REQUIRED]
Amazon Resource Name (ARN) of a resource that has an associated license configuration.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 .
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'
}
)
Filters to scope the results. The following filters and logical operators are supported:
account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS .application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH .license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH .resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS .tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).An inventory filter.
Name of the filter.
Condition of the filter.
Value of the filter.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.
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'
}
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
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 .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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.