String grantArn
Amazon Resource Name (ARN) of the grant.
Date lastRunTime
Time that automated discovery last ran.
String licenseArn
Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.
List<E> entitlements
License entitlements. Partial checkouts are not supported.
String digitalSignatureMethod
Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.
String nodeId
Node ID.
List<E> checkoutMetadata
Information about constraints.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String licenseArn
Amazon Resource Name (ARN) of the license.
String licenseConsumptionToken
License consumption token.
List<E> entitlementsAllowed
Allowed license entitlements.
String nodeId
Node ID.
String signedToken
Signed token.
String issuedAt
Date and time at which the license checkout is issued.
String expiration
Date and time at which the license checkout expires.
List<E> checkoutMetadata
Information about constraints.
String productSKU
Product SKU.
String checkoutType
Checkout type.
String keyFingerprint
Key fingerprint identifying the license.
List<E> entitlements
License entitlements.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String beneficiary
License beneficiary.
String nodeId
Node ID.
String checkoutType
Checkout type.
String licenseConsumptionToken
License consumption token.
List<E> entitlementsAllowed
Allowed license entitlements.
String signedToken
Signed token.
String nodeId
Node ID.
String issuedAt
Date and time at which the license checkout is issued.
String expiration
Date and time at which the license checkout expires.
String licenseArn
Amazon Resource Name (ARN) of the checkout license.
String renewType
Renewal frequency.
ProvisionalConfiguration provisionalConfiguration
Details about a provisional configuration.
BorrowConfiguration borrowConfiguration
Details about a borrow configuration.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String grantName
Grant name.
String licenseArn
Amazon Resource Name (ARN) of the license.
List<E> principals
The grant principals.
String homeRegion
Home Region of the grant.
List<E> allowedOperations
Allowed operations for the grant.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String grantArn
Amazon Resource Name (ARN) of the grant.
String grantName
Grant name.
List<E> allowedOperations
Allowed operations for the grant.
String status
Grant status.
String statusReason
Grant status reason.
String sourceVersion
Current version of the grant.
String name
Name of the license configuration.
String description
Description of the license configuration.
String licenseCountingType
Dimension used to track the license inventory.
Long licenseCount
Number of licenses managed by the license configuration.
Boolean licenseCountHardLimit
Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
List<E> licenseRules
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
Cores dimension: allowedTenancy | licenseAffinityToHost |
maximumCores | minimumCores
Instances dimension: allowedTenancy | maximumCores |
minimumCores | maximumSockets | minimumSockets | maximumVcpus
| minimumVcpus
Sockets dimension: allowedTenancy | licenseAffinityToHost |
maximumSockets | minimumSockets
vCPUs dimension: allowedTenancy | honorVcpuOptimization |
maximumVcpus | minimumVcpus
The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for
allowedTenancy are EC2-Default, EC2-DedicatedHost, and
EC2-DedicatedInstance. The possible values for honorVcpuOptimization are
True and False.
List<E> tags
Tags to add to the license configuration.
Boolean disassociateWhenNotFound
When true, disassociates a resource when software is uninstalled.
List<E> productInformationList
Product information.
String licenseConfigurationArn
Amazon Resource Name (ARN) of the license configuration.
String resourceArn
Amazon Resource Name (ARN) of the resource you are converting the license type for.
LicenseConversionContext sourceLicenseContext
Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the AWS CLI in the License Manager User Guide.
LicenseConversionContext destinationLicenseContext
Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the AWS CLI in the License Manager User Guide.
String licenseConversionTaskId
The ID of the created license type conversion task.
String reportGeneratorName
Name of the report generator.
List<E> type
Type of reports to generate. The following report types an be generated:
License configuration report - Reports the number and details of consumed licenses for a license configuration.
Resource report - Reports the tracked licenses and resource consumption for a license configuration.
ReportContext reportContext
Defines the type of license configuration the report generator tracks.
ReportFrequency reportFrequency
Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String description
Description of the report generator.
List<E> tags
Tags to add to the report generator.
String licenseManagerReportGeneratorArn
The Amazon Resource Name (ARN) of the new report generator.
String licenseName
License name.
String productName
Product name.
String productSKU
Product SKU.
Issuer issuer
License issuer.
String homeRegion
Home Region for the license.
DatetimeRange validity
Date and time range during which the license is valid, in ISO8601-UTC format.
List<E> entitlements
License entitlements.
String beneficiary
License beneficiary.
ConsumptionConfiguration consumptionConfiguration
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.
List<E> licenseMetadata
Information about the license.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String licenseArn
Amazon Resource Name (ARN) of the license.
String licenseName
License name.
String productName
Product name.
Issuer issuer
License issuer.
String homeRegion
Home Region of the license.
DatetimeRange validity
Date and time range during which the license is valid, in ISO8601-UTC format.
List<E> licenseMetadata
Information about the license.
List<E> entitlements
License entitlements.
ConsumptionConfiguration consumptionConfiguration
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.
String status
License status.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String sourceVersion
Current version of the license.
String licenseArn
Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.
List<E> roleArns
Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.
Integer expirationInDays
Token expiration, in days, counted from token creation. The default is 365 days.
List<E> tokenProperties
Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.
String clientToken
Idempotency token, valid for 10 minutes.
String licenseConfigurationArn
ID of the license configuration.
String licenseManagerReportGeneratorArn
Amazon Resource Name (ARN) of the report generator to be deleted.
String tokenId
Token ID.
String name
Entitlement name.
String value
Entitlement resource. Use only if the unit is None.
Long maxCount
Maximum entitlement count. Use if the unit is not None.
Boolean overage
Indicates whether overages are allowed.
String unit
Entitlement unit.
Boolean allowCheckIn
Indicates whether check-ins are allowed.
String errorCode
String accessToken
Temporary access token.
Grant grant
Grant details.
String licenseConfigurationArn
Amazon Resource Name (ARN) of the license configuration.
String licenseConfigurationId
Unique ID for the license configuration.
String licenseConfigurationArn
Amazon Resource Name (ARN) of the license configuration.
String name
Name of the license configuration.
String description
Description of the license configuration.
String licenseCountingType
Dimension for which the licenses are counted.
List<E> licenseRules
License rules.
Long licenseCount
Number of available licenses.
Boolean licenseCountHardLimit
Sets the number of available licenses as a hard limit.
Long consumedLicenses
Number of licenses assigned to resources.
String status
License configuration status.
String ownerAccountId
Account ID of the owner of the license configuration.
List<E> consumedLicenseSummaryList
Summaries of the licenses consumed by resources.
List<E> managedResourceSummaryList
Summaries of the managed resources.
List<E> tags
Tags for the license configuration.
List<E> productInformationList
Product information.
AutomatedDiscoveryInformation automatedDiscoveryInformation
Automated discovery information.
Boolean disassociateWhenNotFound
When true, disassociates a resource when software is uninstalled.
String licenseConversionTaskId
ID of the license type conversion task to retrieve information on.
String licenseConversionTaskId
ID of the license type conversion task.
String resourceArn
Amazon Resource Names (ARN) of the resources the license conversion task is associated with.
LicenseConversionContext sourceLicenseContext
Information about the license type converted from.
LicenseConversionContext destinationLicenseContext
Information about the license type converted to.
String statusMessage
The status message for the conversion task.
String status
Status of the license type conversion task.
Date startTime
Time at which the license type conversion task was started .
Date licenseConversionTime
Amount of time to complete the license type conversion.
Date endTime
Time at which the license type conversion task was completed.
String licenseManagerReportGeneratorArn
Amazon Resource Name (ARN) of the report generator.
ReportGenerator reportGenerator
A report generator that creates periodic reports about your license configurations.
License license
License details.
String licenseArn
Amazon Resource Name (ARN) of the license.
LicenseUsage licenseUsage
License usage details.
String s3BucketArn
Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
String snsTopicArn
SNS topic configured to receive notifications from License Manager.
OrganizationConfiguration organizationConfiguration
Indicates whether Organizations is integrated with License Manager for cross-account discovery.
Boolean enableCrossAccountsDiscovery
Indicates whether cross-account discovery is enabled.
String licenseManagerResourceShareArn
Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.
String grantArn
Amazon Resource Name (ARN) of the grant.
String grantName
Grant name.
String parentArn
Parent ARN.
String licenseArn
License ARN.
String granteePrincipalArn
The grantee principal ARN.
String homeRegion
Home Region of the grant.
String grantStatus
Grant status.
String statusReason
Grant status reason.
String version
Grant version.
List<E> grantedOperations
Granted operations.
String licenseArn
Amazon Resource Name (ARN) of the license.
String licenseName
License name.
String productName
Product name.
String productSKU
Product SKU.
IssuerDetails issuer
Granted license issuer.
String homeRegion
Home Region of the granted license.
String status
Granted license status.
DatetimeRange validity
Date and time range during which the granted license is valid, in ISO8601-UTC format.
String beneficiary
Granted license beneficiary.
List<E> entitlements
License entitlements.
ConsumptionConfiguration consumptionConfiguration
Configuration for consumption of the license.
List<E> licenseMetadata
Granted license metadata.
String createTime
Creation time of the granted license.
String version
Version of the granted license.
ReceivedMetadata receivedMetadata
Granted license received metadata.
String licenseArn
Amazon Resource Name (ARN) of the license.
String licenseName
License name.
String productName
Product name.
String productSKU
Product SKU.
IssuerDetails issuer
License issuer.
String homeRegion
Home Region of the license.
String status
License status.
DatetimeRange validity
Date and time range during which the license is valid, in ISO8601-UTC format.
String beneficiary
License beneficiary.
List<E> entitlements
License entitlements.
ConsumptionConfiguration consumptionConfiguration
Configuration for consumption of the license.
List<E> licenseMetadata
License metadata.
String createTime
License creation time.
String version
License version.
String licenseConfigurationId
Unique ID of the license configuration.
String licenseConfigurationArn
Amazon Resource Name (ARN) of the license configuration.
String name
Name of the license configuration.
String description
Description of the license configuration.
String licenseCountingType
Dimension to use to track the license inventory.
List<E> licenseRules
License rules.
Long licenseCount
Number of licenses managed by the license configuration.
Boolean licenseCountHardLimit
Number of available licenses as a hard limit.
Boolean disassociateWhenNotFound
When true, disassociates a resource when software is uninstalled.
Long consumedLicenses
Number of licenses consumed.
String status
Status of the license configuration.
String ownerAccountId
Account ID of the license configuration's owner.
List<E> consumedLicenseSummaryList
Summaries for licenses consumed by various resources.
List<E> managedResourceSummaryList
Summaries for managed resources.
List<E> productInformationList
Product information.
AutomatedDiscoveryInformation automatedDiscoveryInformation
Automated discovery information.
String resourceArn
Amazon Resource Name (ARN) of the resource.
String resourceType
Type of server resource.
String resourceOwnerId
ID of the Amazon Web Services account that owns the resource consuming licenses.
Date associationTime
Time when the license configuration was associated with the resource.
String amiAssociationScope
Scope of AMI associations. The possible value is cross-account.
String resourceArn
Amazon Resource Name (ARN) of the resource.
String resourceType
Type of resource.
String resourceStatus
Status of the resource.
String resourceOwnerId
ID of the account that owns the resource.
Date associationTime
Time when the license configuration was initially associated with the resource.
Long consumedLicenses
Number of licenses consumed by the resource.
String usageOperation
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
String licenseConversionTaskId
The ID of the license type conversion task.
String resourceArn
The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.
LicenseConversionContext sourceLicenseContext
Information about the license type this conversion task converted from.
LicenseConversionContext destinationLicenseContext
Information about the license type this conversion task converted to.
String status
The status of the conversion task.
String statusMessage
The status message for the conversion task.
Date startTime
The time the conversion task was started at.
Date licenseConversionTime
The time the usage operation value of the resource was changed.
Date endTime
The time the conversion task was completed.
String resourceArn
Amazon Resource Name (ARN) of the resource.
String resourceType
Resource type.
String errorMessage
Error message.
Date failureTime
Failure time.
String operationName
Name of the operation.
String resourceOwnerId
ID of the Amazon Web Services account that owns the resource.
String operationRequestedBy
The requester is "License Manager Automated Discovery".
List<E> metadataList
Reserved.
List<E> grantArns
Amazon Resource Names (ARNs) of the grants.
List<E> filters
Filters to scope the results. The following filters are supported:
LicenseArn
GrantStatus
GranteePrincipalARN
ProductSKU
LicenseIssuerName
String nextToken
Token for the next set of results.
Integer maxResults
Maximum number of results to return in a single call.
List<E> licenseConfigurationArns
Amazon Resource Names (ARN) of the license configurations.
Integer maxResults
Maximum number of results to return in a single call.
String nextToken
Token for the next set of results.
List<E> filters
Filters to scope the results. The following filters and logical operators are supported:
licenseCountingType - The dimension for which licenses are counted. Possible values are
vCPU | Instance | Core | Socket. 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.
List<E> licenseArns
Amazon Resource Names (ARNs) of the licenses.
List<E> filters
Filters to scope the results. The following filters are supported:
Beneficiary
ProductSKU
Fingerprint
Status
String nextToken
Token for the next set of results.
Integer maxResults
Maximum number of results to return in a single call.
List<E> grantArns
Amazon Resource Names (ARNs) of the grants.
List<E> filters
Filters to scope the results. The following filters are supported:
ProductSKU
LicenseIssuerName
LicenseArn
GrantStatus
GranterAccountId
String nextToken
Token for the next set of results.
Integer maxResults
Maximum number of results to return in a single call.
List<E> licenseArns
Amazon Resource Names (ARNs) of the licenses.
List<E> filters
Filters to scope the results. The following filters are supported:
ProductSKU
Status
Fingerprint
IssuerName
Beneficiary
String nextToken
Token for the next set of results.
Integer maxResults
Maximum number of results to return in a single call.
Integer maxResults
Maximum number of results to return in a single call.
String nextToken
Token for the next set of results.
List<E> filters
Filters to scope the results. The following filters and logical operators are supported:
account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are
EQUALS | NOT_EQUALS.
application_name - The name of the application. Logical operators are EQUALS |
BEGINS_WITH.
license_included - The type of license included. Logical operators are EQUALS |
NOT_EQUALS. Possible values are sql-server-enterprise |
sql-server-standard | sql-server-web | windows-server-datacenter.
platform - The platform of the resource. Logical operators are EQUALS |
BEGINS_WITH.
resource_id - The ID of the resource. Logical operators are EQUALS |
NOT_EQUALS.
tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are
EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).
String resourceArn
Amazon Resource Name (ARN) of the license configuration.
String licenseConfigurationArn
Amazon Resource Name (ARN) of the license configuration.
Integer maxResults
Maximum number of results to return in a single call.
String nextToken
Token for the next set of results.
List<E> filters
Filters to scope the results. The following filters and logical operators are supported:
resourceArn - The ARN of the license configuration resource. Logical operators are
EQUALS | NOT_EQUALS.
resourceType - The resource type (EC2_INSTANCE | EC2_HOST |
EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS
| NOT_EQUALS.
resourceAccount - The ID of the account that owns the resource. Logical operators are
EQUALS | NOT_EQUALS.
Boolean enableIntegration
Enables Organizations integration.
String resourceType
Resource type. The possible values are SSM_MANAGED | RDS.
List<E> productInformationFilterList
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.
Integer maxTimeToLiveInMinutes
Maximum time for the provisional configuration, in minutes.
String location
String grantArn
Amazon Resource Name (ARN) of the grant.
String reportGeneratorName
Name of the report generator.
List<E> reportType
Type of reports that are generated.
ReportContext reportContext
License configuration type for this generator.
ReportFrequency reportFrequency
Details about how frequently reports are generated.
String licenseManagerReportGeneratorArn
Amazon Resource Name (ARN) of the report generator.
String lastRunStatus
Status of the last report generation attempt.
String lastRunFailureReason
Failure message for the last report generation attempt.
String lastReportGenerationTime
Time the last report was generated at.
String reportCreatorAccount
The Amazon Web Services account ID used to create the report generator.
String description
Description of the report generator.
S3Location s3Location
Details of the S3 bucket that report generator reports are published to.
String createTime
Time the report was created.
List<E> tags
Tags associated with the report generator.
String resourceId
ID of the resource.
String resourceType
Type of resource.
String resourceArn
Amazon Resource Name (ARN) of the resource.
String platform
Platform of the resource.
String platformVersion
Platform version of the resource in the inventory.
String resourceOwningAccountId
ID of the account that owns the resource.
String tokenId
Token ID.
String tokenType
Type of token generated. The supported value is REFRESH_TOKEN.
String licenseArn
Amazon Resource Name (ARN) of the license.
String expirationTime
Token expiration time, in ISO8601-UTC format.
List<E> tokenProperties
Data specified by the caller.
List<E> roleArns
Amazon Resource Names (ARN) of the roles included in the token.
String status
Token status. The possible values are AVAILABLE and DELETED.
String licenseConfigurationArn
Amazon Resource Name (ARN) of the license configuration.
String licenseConfigurationStatus
New status of the license configuration.
List<E> licenseRules
New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.
Long licenseCount
New number of licenses managed by the license configuration.
Boolean licenseCountHardLimit
New hard limit of the number of available licenses.
String name
New name of the license configuration.
String description
New description of the license configuration.
List<E> productInformationList
New product information.
Boolean disassociateWhenNotFound
When true, disassociates a resource when software is uninstalled.
String licenseManagerReportGeneratorArn
Amazon Resource Name (ARN) of the report generator to update.
String reportGeneratorName
Name of the report generator.
List<E> type
Type of reports to generate. The following report types are supported:
License configuration report - Reports the number and details of consumed licenses for a license configuration.
Resource report - Reports the tracked licenses and resource consumption for a license configuration.
ReportContext reportContext
The report context.
ReportFrequency reportFrequency
Frequency by which reports are generated.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String description
Description of the report generator.
String resourceArn
Amazon Resource Name (ARN) of the Amazon Web Services resource.
List<E> addLicenseSpecifications
ARNs of the license configurations to add.
List<E> removeLicenseSpecifications
ARNs of the license configurations to remove.
String s3BucketArn
Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.
String snsTopicArn
Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.
OrganizationConfiguration organizationConfiguration
Enables integration with Organizations for cross-account discovery.
Boolean enableCrossAccountsDiscovery
Activates cross-account discovery.
Copyright © 2022. All rights reserved.