ListReceivedLicensesForOrganizationCommand

Suggest an Edit

Lists the licenses received for all accounts in the organization.

Example Syntax

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

import { LicenseManagerClient, ListReceivedLicensesForOrganizationCommand } from "@aws-sdk/client-license-manager"; // ES Modules import
// const { LicenseManagerClient, ListReceivedLicensesForOrganizationCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import
const client = new LicenseManagerClient(config);
const input = { // ListReceivedLicensesForOrganizationRequest
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // FilterValues
        "STRING_VALUE",
      ],
    },
  ],
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListReceivedLicensesForOrganizationCommand(input);
const response = await client.send(command);
// { // ListReceivedLicensesForOrganizationResponse
//   Licenses: [ // GrantedLicenseList
//     { // GrantedLicense
//       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",
//       ReceivedMetadata: { // ReceivedMetadata
//         ReceivedStatus: "PENDING_WORKFLOW" || "PENDING_ACCEPT" || "REJECTED" || "ACTIVE" || "FAILED_WORKFLOW" || "DELETED" || "DISABLED" || "WORKFLOW_COMPLETED",
//         ReceivedStatusReason: "STRING_VALUE",
//         AllowedOperations: [ // AllowedOperationList
//           "CreateGrant" || "CheckoutLicense" || "CheckoutBorrowLicense" || "CheckInLicense" || "ExtendConsumptionLicense" || "ListPurchasedLicenses" || "CreateToken",
//         ],
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListReceivedLicensesForOrganizationCommand Input

See ListReceivedLicensesForOrganizationCommandInput for more details

Parameter
Type
Description
Filters
Filter[] | undefined

Filters to scope the results. The following filters are supported:

  • Beneficiary

  • ProductSKU

MaxResults
number | undefined

Maximum number of results to return in a single call.

NextToken
string | undefined

Token for the next set of results.

ListReceivedLicensesForOrganizationCommand Output

See ListReceivedLicensesForOrganizationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Licenses
GrantedLicense[] | undefined

Lists the licenses the organization has received.

NextToken
string | undefined

Token for the next set of results.

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.

ResourceLimitExceededException
client

Your resource limits have been exceeded.

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.