LicenseManager class

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

Constructors

LicenseManager({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

acceptGrant({required String grantArn}) → Future<AcceptGrantResponse>

Accepts the specified grant.

checkInLicense({required String licenseConsumptionToken, String? beneficiary}) → Future<void>

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

checkoutBorrowLicense({required String clientToken, required DigitalSignatureMethod digitalSignatureMethod, required List<EntitlementData> entitlements, required String licenseArn, List<Metadata>? checkoutMetadata, String? nodeId}) → Future<CheckoutBorrowLicenseResponse>

Checks out the specified license for offline use.

checkoutLicense({required CheckoutType checkoutType, required String clientToken, required List<EntitlementData> entitlements, required String keyFingerprint, required String productSKU, String? beneficiary, String? nodeId}) → Future<CheckoutLicenseResponse>

Checks out the specified license.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createGrant({required List<AllowedOperation> allowedOperations, required String clientToken, required String grantName, required String homeRegion, required String licenseArn, required List<String> principals}) → Future<CreateGrantResponse>

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

createGrantVersion({required String clientToken, required String grantArn, List<AllowedOperation>? allowedOperations, String? grantName, String? sourceVersion, GrantStatus? status}) → Future<CreateGrantVersionResponse>

Creates a new version of the specified grant.

createLicense({required String beneficiary, required String clientToken, required ConsumptionConfiguration consumptionConfiguration, required List<Entitlement> entitlements, required String homeRegion, required Issuer issuer, required String licenseName, required String productName, required String productSKU, required DatetimeRange validity, List<Metadata>? licenseMetadata}) → Future<CreateLicenseResponse>

Creates a license.

createLicenseConfiguration({required LicenseCountingType licenseCountingType, required String name, String? description, bool? disassociateWhenNotFound, int? licenseCount, bool? licenseCountHardLimit, List<String>? licenseRules, List<ProductInformation>? productInformationList, List<Tag>? tags}) → Future<CreateLicenseConfigurationResponse>

Creates a license configuration.

createLicenseVersion({required String clientToken, required ConsumptionConfiguration consumptionConfiguration, required List<Entitlement> entitlements, required String homeRegion, required Issuer issuer, required String licenseArn, required String licenseName, required String productName, required LicenseStatus status, required DatetimeRange validity, List<Metadata>? licenseMetadata, String? sourceVersion}) → Future<CreateLicenseVersionResponse>

Creates a new version of the specified license.

createToken({required String clientToken, required String licenseArn, int? expirationInDays, List<String>? roleArns, List<String>? tokenProperties}) → Future<CreateTokenResponse>

Creates a long-lived token.

deleteGrant({required String grantArn, required String version}) → Future<DeleteGrantResponse>

Deletes the specified grant.

deleteLicense({required String licenseArn, required String sourceVersion}) → Future<DeleteLicenseResponse>

Deletes the specified license.

deleteLicenseConfiguration({required String licenseConfigurationArn}) → Future<void>

Deletes the specified license configuration.

deleteToken({required String tokenId}) → Future<void>

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

extendLicenseConsumption({required String licenseConsumptionToken, bool? dryRun}) → Future<ExtendLicenseConsumptionResponse>

Extends the expiration date for license consumption.

getAccessToken({required String token, List<String>? tokenProperties}) → Future<GetAccessTokenResponse>

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

getGrant({required String grantArn, String? version}) → Future<GetGrantResponse>

Gets detailed information about the specified grant.

getLicense({required String licenseArn, String? version}) → Future<GetLicenseResponse>

Gets detailed information about the specified license.

getLicenseConfiguration({required String licenseConfigurationArn}) → Future<GetLicenseConfigurationResponse>

Gets detailed information about the specified license configuration.

getLicenseUsage({required String licenseArn}) → Future<GetLicenseUsageResponse>

Gets detailed information about the usage of the specified license.

getServiceSettings() → Future<GetServiceSettingsResponse>

Gets the License Manager settings for the current Region.

listAssociationsForLicenseConfiguration({required String licenseConfigurationArn, int? maxResults, String? nextToken}) → Future<ListAssociationsForLicenseConfigurationResponse>

Lists the resource associations for the specified license configuration.

listDistributedGrants({List<Filter>? filters, List<String>? grantArns, int? maxResults, String? nextToken}) → Future<ListDistributedGrantsResponse>

Lists the grants distributed for the specified license.

listFailuresForLicenseConfigurationOperations({required String licenseConfigurationArn, int? maxResults, String? nextToken}) → Future<ListFailuresForLicenseConfigurationOperationsResponse>

Lists the license configuration operations that failed.

listLicenseConfigurations({List<Filter>? filters, List<String>? licenseConfigurationArns, int? maxResults, String? nextToken}) → Future<ListLicenseConfigurationsResponse>

Lists the license configurations for your account.

listLicenses({List<Filter>? filters, List<String>? licenseArns, int? maxResults, String? nextToken}) → Future<ListLicensesResponse>

Lists the licenses for your account.

listLicenseSpecificationsForResource({required String resourceArn, int? maxResults, String? nextToken}) → Future<ListLicenseSpecificationsForResourceResponse>

Describes the license configurations for the specified resource.

listLicenseVersions({required String licenseArn, int? maxResults, String? nextToken}) → Future<ListLicenseVersionsResponse>

Lists all versions of the specified license.

listReceivedGrants({List<Filter>? filters, List<String>? grantArns, int? maxResults, String? nextToken}) → Future<ListReceivedGrantsResponse>

Lists grants that are received but not accepted.

listReceivedLicenses({List<Filter>? filters, List<String>? licenseArns, int? maxResults, String? nextToken}) → Future<ListReceivedLicensesResponse>

Lists received licenses.

listResourceInventory({List<InventoryFilter>? filters, int? maxResults, String? nextToken}) → Future<ListResourceInventoryResponse>

Lists resources managed using Systems Manager inventory.

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

Lists the tags for the specified license configuration.

listTokens({List<Filter>? filters, int? maxResults, String? nextToken, List<String>? tokenIds}) → Future<ListTokensResponse>

Lists your tokens.

listUsageForLicenseConfiguration({required String licenseConfigurationArn, List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListUsageForLicenseConfigurationResponse>

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.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rejectGrant({required String grantArn}) → Future<RejectGrantResponse>

Rejects the specified grant.

tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>

Adds the specified tags to the specified license configuration.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Removes the specified tags from the specified license configuration.

updateLicenseConfiguration({required String licenseConfigurationArn, String? description, bool? disassociateWhenNotFound, LicenseConfigurationStatus? licenseConfigurationStatus, int? licenseCount, bool? licenseCountHardLimit, List<String>? licenseRules, String? name, List<ProductInformation>? productInformationList}) → Future<void>

Modifies the attributes of an existing license configuration.

updateLicenseSpecificationsForResource({required String resourceArn, List<LicenseSpecification>? addLicenseSpecifications, List<LicenseSpecification>? removeLicenseSpecifications}) → Future<void>

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

updateServiceSettings({bool? enableCrossAccountsDiscovery, OrganizationConfiguration? organizationConfiguration, String? s3BucketArn, String? snsTopicArn}) → Future<void>

Updates License Manager settings for the current Region.

Operators

operator ==(Object other) → bool

The equality operator.

inherited