LicenseManager

import { LicenseManager } from "https://aws-api.deno.dev/v0.4/services/licensemanager.ts?docs=full";

class LicenseManager {

constructor(apiFactory: client.ApiFactory);

async acceptGrant(params: AcceptGrantRequest, opts?: client.RequestOptions): Promise<AcceptGrantResponse>;

async checkInLicense(params: CheckInLicenseRequest, opts?: client.RequestOptions): Promise<void>;

async checkoutBorrowLicense(params: CheckoutBorrowLicenseRequest, opts?: client.RequestOptions): Promise<CheckoutBorrowLicenseResponse>;

async checkoutLicense(params: CheckoutLicenseRequest, opts?: client.RequestOptions): Promise<CheckoutLicenseResponse>;

async createGrant(params: CreateGrantRequest, opts?: client.RequestOptions): Promise<CreateGrantResponse>;

async createGrantVersion(params: CreateGrantVersionRequest, opts?: client.RequestOptions): Promise<CreateGrantVersionResponse>;

async createLicense(params: CreateLicenseRequest, opts?: client.RequestOptions): Promise<CreateLicenseResponse>;

async createLicenseConfiguration(params: CreateLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<CreateLicenseConfigurationResponse>;

async createLicenseConversionTaskForResource(params: CreateLicenseConversionTaskForResourceRequest, opts?: client.RequestOptions): Promise<CreateLicenseConversionTaskForResourceResponse>;

async createLicenseManagerReportGenerator(params: CreateLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<CreateLicenseManagerReportGeneratorResponse>;

async createLicenseVersion(params: CreateLicenseVersionRequest, opts?: client.RequestOptions): Promise<CreateLicenseVersionResponse>;

async createToken(params: CreateTokenRequest, opts?: client.RequestOptions): Promise<CreateTokenResponse>;

async deleteGrant(params: DeleteGrantRequest, opts?: client.RequestOptions): Promise<DeleteGrantResponse>;

async deleteLicense(params: DeleteLicenseRequest, opts?: client.RequestOptions): Promise<DeleteLicenseResponse>;

async deleteLicenseConfiguration(params: DeleteLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteLicenseManagerReportGenerator(params: DeleteLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<void>;

async deleteToken(params: DeleteTokenRequest, opts?: client.RequestOptions): Promise<void>;

async extendLicenseConsumption(params: ExtendLicenseConsumptionRequest, opts?: client.RequestOptions): Promise<ExtendLicenseConsumptionResponse>;

async getAccessToken(params: GetAccessTokenRequest, opts?: client.RequestOptions): Promise<GetAccessTokenResponse>;

async getGrant(params: GetGrantRequest, opts?: client.RequestOptions): Promise<GetGrantResponse>;

async getLicense(params: GetLicenseRequest, opts?: client.RequestOptions): Promise<GetLicenseResponse>;

async getLicenseConfiguration(params: GetLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<GetLicenseConfigurationResponse>;

async getLicenseConversionTask(params: GetLicenseConversionTaskRequest, opts?: client.RequestOptions): Promise<GetLicenseConversionTaskResponse>;

async getLicenseManagerReportGenerator(params: GetLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<GetLicenseManagerReportGeneratorResponse>;

async getLicenseUsage(params: GetLicenseUsageRequest, opts?: client.RequestOptions): Promise<GetLicenseUsageResponse>;

async getServiceSettings(opts?: client.RequestOptions): Promise<GetServiceSettingsResponse>;

async listAssociationsForLicenseConfiguration(params: ListAssociationsForLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<ListAssociationsForLicenseConfigurationResponse>;

async listDistributedGrants(params?: ListDistributedGrantsRequest, opts?: client.RequestOptions): Promise<ListDistributedGrantsResponse>;

async listFailuresForLicenseConfigurationOperations(params: ListFailuresForLicenseConfigurationOperationsRequest, opts?: client.RequestOptions): Promise<ListFailuresForLicenseConfigurationOperationsResponse>;

async listLicenseConfigurations(params?: ListLicenseConfigurationsRequest, opts?: client.RequestOptions): Promise<ListLicenseConfigurationsResponse>;

async listLicenseConversionTasks(params?: ListLicenseConversionTasksRequest, opts?: client.RequestOptions): Promise<ListLicenseConversionTasksResponse>;

async listLicenseManagerReportGenerators(params?: ListLicenseManagerReportGeneratorsRequest, opts?: client.RequestOptions): Promise<ListLicenseManagerReportGeneratorsResponse>;

async listLicenses(params?: ListLicensesRequest, opts?: client.RequestOptions): Promise<ListLicensesResponse>;

async listLicenseSpecificationsForResource(params: ListLicenseSpecificationsForResourceRequest, opts?: client.RequestOptions): Promise<ListLicenseSpecificationsForResourceResponse>;

async listLicenseVersions(params: ListLicenseVersionsRequest, opts?: client.RequestOptions): Promise<ListLicenseVersionsResponse>;

async listReceivedGrants(params?: ListReceivedGrantsRequest, opts?: client.RequestOptions): Promise<ListReceivedGrantsResponse>;

async listReceivedGrantsForOrganization(params: ListReceivedGrantsForOrganizationRequest, opts?: client.RequestOptions): Promise<ListReceivedGrantsForOrganizationResponse>;

async listReceivedLicenses(params?: ListReceivedLicensesRequest, opts?: client.RequestOptions): Promise<ListReceivedLicensesResponse>;

async listReceivedLicensesForOrganization(params?: ListReceivedLicensesForOrganizationRequest, opts?: client.RequestOptions): Promise<ListReceivedLicensesForOrganizationResponse>;

async listResourceInventory(params?: ListResourceInventoryRequest, opts?: client.RequestOptions): Promise<ListResourceInventoryResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTokens(params?: ListTokensRequest, opts?: client.RequestOptions): Promise<ListTokensResponse>;

async listUsageForLicenseConfiguration(params: ListUsageForLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<ListUsageForLicenseConfigurationResponse>;

async rejectGrant(params: RejectGrantRequest, opts?: client.RequestOptions): Promise<RejectGrantResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateLicenseConfiguration(params: UpdateLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async updateLicenseManagerReportGenerator(params: UpdateLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<void>;

async updateLicenseSpecificationsForResource(params: UpdateLicenseSpecificationsForResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateServiceSettings(params?: UpdateServiceSettingsRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new LicenseManager(apiFactory: client.ApiFactory)

[src]

§Methods

acceptGrant(params: AcceptGrantRequest, opts?: client.RequestOptions): Promise<AcceptGrantResponse>

[src]

Accepts the specified grant.

checkInLicense(params: CheckInLicenseRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

checkoutBorrowLicense(params: CheckoutBorrowLicenseRequest, opts?: client.RequestOptions): Promise<CheckoutBorrowLicenseResponse>

[src]

Checks out the specified license for offline use.

checkoutLicense(params: CheckoutLicenseRequest, opts?: client.RequestOptions): Promise<CheckoutLicenseResponse>

[src]

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.

createGrant(params: CreateGrantRequest, opts?: client.RequestOptions): Promise<CreateGrantResponse>

[src]

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

createGrantVersion(params: CreateGrantVersionRequest, opts?: client.RequestOptions): Promise<CreateGrantVersionResponse>

[src]

Creates a new version of the specified grant.

createLicense(params: CreateLicenseRequest, opts?: client.RequestOptions): Promise<CreateLicenseResponse>

[src]

Creates a license.

createLicenseConfiguration(params: CreateLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<CreateLicenseConfigurationResponse>

[src]

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.

createLicenseConversionTaskForResource(params: CreateLicenseConversionTaskForResourceRequest, opts?: client.RequestOptions): Promise<CreateLicenseConversionTaskForResourceResponse>

[src]

Creates a new license conversion task.

createLicenseManagerReportGenerator(params: CreateLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<CreateLicenseManagerReportGeneratorResponse>

[src]

Creates a report generator.

createLicenseVersion(params: CreateLicenseVersionRequest, opts?: client.RequestOptions): Promise<CreateLicenseVersionResponse>

[src]

Creates a new version of the specified license.

createToken(params: CreateTokenRequest, opts?: client.RequestOptions): Promise<CreateTokenResponse>

[src]

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.

deleteGrant(params: DeleteGrantRequest, opts?: client.RequestOptions): Promise<DeleteGrantResponse>

[src]

Deletes the specified grant.

deleteLicense(params: DeleteLicenseRequest, opts?: client.RequestOptions): Promise<DeleteLicenseResponse>

[src]

Deletes the specified license.

deleteLicenseConfiguration(params: DeleteLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified license configuration.

You cannot delete a license configuration that is in use.

deleteLicenseManagerReportGenerator(params: DeleteLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteToken(params: DeleteTokenRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

extendLicenseConsumption(params: ExtendLicenseConsumptionRequest, opts?: client.RequestOptions): Promise<ExtendLicenseConsumptionResponse>

[src]

Extends the expiration date for license consumption.

getAccessToken(params: GetAccessTokenRequest, opts?: client.RequestOptions): Promise<GetAccessTokenResponse>

[src]

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

getGrant(params: GetGrantRequest, opts?: client.RequestOptions): Promise<GetGrantResponse>

[src]

Gets detailed information about the specified grant.

getLicense(params: GetLicenseRequest, opts?: client.RequestOptions): Promise<GetLicenseResponse>

[src]

Gets detailed information about the specified license.

getLicenseConfiguration(params: GetLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<GetLicenseConfigurationResponse>

[src]

Gets detailed information about the specified license configuration.

getLicenseConversionTask(params: GetLicenseConversionTaskRequest, opts?: client.RequestOptions): Promise<GetLicenseConversionTaskResponse>

[src]

Gets information about the specified license type conversion task.

getLicenseManagerReportGenerator(params: GetLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<GetLicenseManagerReportGeneratorResponse>

[src]

Gets information about the specified report generator.

getLicenseUsage(params: GetLicenseUsageRequest, opts?: client.RequestOptions): Promise<GetLicenseUsageResponse>

[src]

Gets detailed information about the usage of the specified license.

getServiceSettings(opts?: client.RequestOptions): Promise<GetServiceSettingsResponse>

[src]

Gets the License Manager settings for the current Region.

listAssociationsForLicenseConfiguration(params: ListAssociationsForLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<ListAssociationsForLicenseConfigurationResponse>

[src]

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

listDistributedGrants(params?: ListDistributedGrantsRequest, opts?: client.RequestOptions): Promise<ListDistributedGrantsResponse>

[src]

Lists the grants distributed for the specified license.

listFailuresForLicenseConfigurationOperations(params: ListFailuresForLicenseConfigurationOperationsRequest, opts?: client.RequestOptions): Promise<ListFailuresForLicenseConfigurationOperationsResponse>

[src]

Lists the license configuration operations that failed.

listLicenseConfigurations(params?: ListLicenseConfigurationsRequest, opts?: client.RequestOptions): Promise<ListLicenseConfigurationsResponse>

[src]

Lists the license configurations for your account.

listLicenseConversionTasks(params?: ListLicenseConversionTasksRequest, opts?: client.RequestOptions): Promise<ListLicenseConversionTasksResponse>

[src]

Lists the license type conversion tasks for your account.

listLicenseManagerReportGenerators(params?: ListLicenseManagerReportGeneratorsRequest, opts?: client.RequestOptions): Promise<ListLicenseManagerReportGeneratorsResponse>

[src]

Lists the report generators for your account.

listLicenses(params?: ListLicensesRequest, opts?: client.RequestOptions): Promise<ListLicensesResponse>

[src]

Lists the licenses for your account.

listLicenseSpecificationsForResource(params: ListLicenseSpecificationsForResourceRequest, opts?: client.RequestOptions): Promise<ListLicenseSpecificationsForResourceResponse>

[src]

Describes the license configurations for the specified resource.

listLicenseVersions(params: ListLicenseVersionsRequest, opts?: client.RequestOptions): Promise<ListLicenseVersionsResponse>

[src]

Lists all versions of the specified license.

listReceivedGrants(params?: ListReceivedGrantsRequest, opts?: client.RequestOptions): Promise<ListReceivedGrantsResponse>

[src]

Lists grants that are received but not accepted.

listReceivedGrantsForOrganization(params: ListReceivedGrantsForOrganizationRequest, opts?: client.RequestOptions): Promise<ListReceivedGrantsForOrganizationResponse>

[src]

Lists the grants received for all accounts in the organization.

listReceivedLicenses(params?: ListReceivedLicensesRequest, opts?: client.RequestOptions): Promise<ListReceivedLicensesResponse>

[src]

Lists received licenses.

listReceivedLicensesForOrganization(params?: ListReceivedLicensesForOrganizationRequest, opts?: client.RequestOptions): Promise<ListReceivedLicensesForOrganizationResponse>

[src]

Lists the licenses received for all accounts in the organization.

listResourceInventory(params?: ListResourceInventoryRequest, opts?: client.RequestOptions): Promise<ListResourceInventoryResponse>

[src]

Lists resources managed using Systems Manager inventory.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags for the specified license configuration.

listTokens(params?: ListTokensRequest, opts?: client.RequestOptions): Promise<ListTokensResponse>

[src]

Lists your tokens.

listUsageForLicenseConfiguration(params: ListUsageForLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<ListUsageForLicenseConfigurationResponse>

[src]

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.

rejectGrant(params: RejectGrantRequest, opts?: client.RequestOptions): Promise<RejectGrantResponse>

[src]

Rejects the specified grant.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds the specified tags to the specified license configuration.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the specified tags from the specified license configuration.

updateLicenseConfiguration(params: UpdateLicenseConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Modifies the attributes of an existing license configuration.

updateLicenseManagerReportGenerator(params: UpdateLicenseManagerReportGeneratorRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a report generator.

After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.

updateLicenseSpecificationsForResource(params: UpdateLicenseSpecificationsForResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateServiceSettings(params?: UpdateServiceSettingsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates License Manager settings for the current Region.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]