GetLicenseCommand

Suggest an Edit

Gets detailed information about the specified license.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LicenseManagerClient, GetLicenseCommand } from "@aws-sdk/client-license-manager"; // ES Modules import
// const { LicenseManagerClient, GetLicenseCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import
const client = new LicenseManagerClient(config);
const input = { // GetLicenseRequest
  LicenseArn: "STRING_VALUE", // required
  Version: "STRING_VALUE",
};
const command = new GetLicenseCommand(input);
const response = await client.send(command);
// { // GetLicenseResponse
//   License: { // License
//     LicenseArn: "STRING_VALUE",
//     LicenseName: "STRING_VALUE",
//     ProductName: "STRING_VALUE",
//     ProductSKU: "STRING_VALUE",
//     Issuer: { // IssuerDetails
//       Name: "STRING_VALUE",
//       SignKey: "STRING_VALUE",
//       KeyFingerprint: "STRING_VALUE",
//     },
//     HomeRegion: "STRING_VALUE",
//     Status: "AVAILABLE" || "PENDING_AVAILABLE" || "DEACTIVATED" || "SUSPENDED" || "EXPIRED" || "PENDING_DELETE" || "DELETED",
//     Validity: { // DatetimeRange
//       Begin: "STRING_VALUE", // required
//       End: "STRING_VALUE",
//     },
//     Beneficiary: "STRING_VALUE",
//     Entitlements: [ // EntitlementList
//       { // Entitlement
//         Name: "STRING_VALUE", // required
//         Value: "STRING_VALUE",
//         MaxCount: Number("long"),
//         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", // required
//         AllowCheckIn: true || false,
//       },
//     ],
//     ConsumptionConfiguration: { // ConsumptionConfiguration
//       RenewType: "None" || "Weekly" || "Monthly",
//       ProvisionalConfiguration: { // ProvisionalConfiguration
//         MaxTimeToLiveInMinutes: Number("int"), // required
//       },
//       BorrowConfiguration: { // BorrowConfiguration
//         AllowEarlyCheckIn: true || false, // required
//         MaxTimeToLiveInMinutes: Number("int"), // required
//       },
//     },
//     LicenseMetadata: [ // MetadataList
//       { // Metadata
//         Name: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     CreateTime: "STRING_VALUE",
//     Version: "STRING_VALUE",
//   },
// };

GetLicenseCommand Input

See GetLicenseCommandInput for more details

Parameter
Type
Description
LicenseArn
Required
string | undefined

Amazon Resource Name (ARN) of the license.

Version
string | undefined

License version.

GetLicenseCommand Output

See GetLicenseCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
License
License | undefined

License details.

Throws

Name
Fault
Details
AccessDeniedException
client

Access to resource denied.

AuthorizationException
client

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

InvalidParameterValueException
client

One or more parameter values are not valid.

RateLimitExceededException
client

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

ServerInternalException
server

The server experienced an internal error. Try again.

ValidationException
client

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

LicenseManagerServiceException
Base exception class for all service exceptions from LicenseManager service.