1. Packages
  2. AWS
  3. API Docs
  4. licensemanager
  5. getReceivedLicense
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.licensemanager.getReceivedLicense

Explore with Pulumi AI

This resource can be used to get data on a received license using an ARN. This can be helpful for pulling in data on a license from the AWS marketplace and sharing that license with another account.

Example Usage

The following shows getting the received license data using and ARN.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.licensemanager.getReceivedLicense({
    licenseArn: "arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0",
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.licensemanager.get_received_license(license_arn="arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/licensemanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := licensemanager.GetReceivedLicense(ctx, &licensemanager.GetReceivedLicenseArgs{
			LicenseArn: "arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.LicenseManager.GetReceivedLicense.Invoke(new()
    {
        LicenseArn = "arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.licensemanager.LicensemanagerFunctions;
import com.pulumi.aws.licensemanager.inputs.GetReceivedLicenseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = LicensemanagerFunctions.getReceivedLicense(GetReceivedLicenseArgs.builder()
            .licenseArn("arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: aws:licensemanager:getReceivedLicense
      arguments:
        licenseArn: arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0
Copy

Using getReceivedLicense

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getReceivedLicense(args: GetReceivedLicenseArgs, opts?: InvokeOptions): Promise<GetReceivedLicenseResult>
function getReceivedLicenseOutput(args: GetReceivedLicenseOutputArgs, opts?: InvokeOptions): Output<GetReceivedLicenseResult>
Copy
def get_received_license(license_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetReceivedLicenseResult
def get_received_license_output(license_arn: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetReceivedLicenseResult]
Copy
func GetReceivedLicense(ctx *Context, args *GetReceivedLicenseArgs, opts ...InvokeOption) (*GetReceivedLicenseResult, error)
func GetReceivedLicenseOutput(ctx *Context, args *GetReceivedLicenseOutputArgs, opts ...InvokeOption) GetReceivedLicenseResultOutput
Copy

> Note: This function is named GetReceivedLicense in the Go SDK.

public static class GetReceivedLicense 
{
    public static Task<GetReceivedLicenseResult> InvokeAsync(GetReceivedLicenseArgs args, InvokeOptions? opts = null)
    public static Output<GetReceivedLicenseResult> Invoke(GetReceivedLicenseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReceivedLicenseResult> getReceivedLicense(GetReceivedLicenseArgs args, InvokeOptions options)
public static Output<GetReceivedLicenseResult> getReceivedLicense(GetReceivedLicenseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:licensemanager/getReceivedLicense:getReceivedLicense
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LicenseArn This property is required. string
The ARN of the received license you want data for.
LicenseArn This property is required. string
The ARN of the received license you want data for.
licenseArn This property is required. String
The ARN of the received license you want data for.
licenseArn This property is required. string
The ARN of the received license you want data for.
license_arn This property is required. str
The ARN of the received license you want data for.
licenseArn This property is required. String
The ARN of the received license you want data for.

getReceivedLicense Result

The following output properties are available:

Beneficiary string
Granted license beneficiary. This is in the form of the ARN of the root user of the account.
ConsumptionConfigurations List<GetReceivedLicenseConsumptionConfiguration>
Configuration for consumption of the license. Detailed below
CreateTime string
Creation time of the granted license in RFC 3339 format.
Entitlements List<GetReceivedLicenseEntitlement>
License entitlements. Detailed below
HomeRegion string
Home Region of the granted license.
Id string
The provider-assigned unique ID for this managed resource.
Issuers List<GetReceivedLicenseIssuer>
Granted license issuer. Detailed below
LicenseArn string
Amazon Resource Name (ARN) of the license.
LicenseMetadatas List<GetReceivedLicenseLicenseMetadata>
Granted license metadata. This is in the form of a set of all meta data. Detailed below
LicenseName string
License name.
ProductName string
Product name.

  • product_sku - Product SKU.
ProductSku string
ReceivedMetadatas List<GetReceivedLicenseReceivedMetadata>
Granted license received metadata. Detailed below
Status string
Granted license status.
Validities List<GetReceivedLicenseValidity>
Date and time range during which the granted license is valid, in ISO8601-UTC format. Detailed below
Version string
Version of the granted license.
Beneficiary string
Granted license beneficiary. This is in the form of the ARN of the root user of the account.
ConsumptionConfigurations []GetReceivedLicenseConsumptionConfiguration
Configuration for consumption of the license. Detailed below
CreateTime string
Creation time of the granted license in RFC 3339 format.
Entitlements []GetReceivedLicenseEntitlement
License entitlements. Detailed below
HomeRegion string
Home Region of the granted license.
Id string
The provider-assigned unique ID for this managed resource.
Issuers []GetReceivedLicenseIssuer
Granted license issuer. Detailed below
LicenseArn string
Amazon Resource Name (ARN) of the license.
LicenseMetadatas []GetReceivedLicenseLicenseMetadata
Granted license metadata. This is in the form of a set of all meta data. Detailed below
LicenseName string
License name.
ProductName string
Product name.

  • product_sku - Product SKU.
ProductSku string
ReceivedMetadatas []GetReceivedLicenseReceivedMetadata
Granted license received metadata. Detailed below
Status string
Granted license status.
Validities []GetReceivedLicenseValidity
Date and time range during which the granted license is valid, in ISO8601-UTC format. Detailed below
Version string
Version of the granted license.
beneficiary String
Granted license beneficiary. This is in the form of the ARN of the root user of the account.
consumptionConfigurations List<GetReceivedLicenseConsumptionConfiguration>
Configuration for consumption of the license. Detailed below
createTime String
Creation time of the granted license in RFC 3339 format.
entitlements List<GetReceivedLicenseEntitlement>
License entitlements. Detailed below
homeRegion String
Home Region of the granted license.
id String
The provider-assigned unique ID for this managed resource.
issuers List<GetReceivedLicenseIssuer>
Granted license issuer. Detailed below
licenseArn String
Amazon Resource Name (ARN) of the license.
licenseMetadatas List<GetReceivedLicenseLicenseMetadata>
Granted license metadata. This is in the form of a set of all meta data. Detailed below
licenseName String
License name.
productName String
Product name.

  • product_sku - Product SKU.
productSku String
receivedMetadatas List<GetReceivedLicenseReceivedMetadata>
Granted license received metadata. Detailed below
status String
Granted license status.
validities List<GetReceivedLicenseValidity>
Date and time range during which the granted license is valid, in ISO8601-UTC format. Detailed below
version String
Version of the granted license.
beneficiary string
Granted license beneficiary. This is in the form of the ARN of the root user of the account.
consumptionConfigurations GetReceivedLicenseConsumptionConfiguration[]
Configuration for consumption of the license. Detailed below
createTime string
Creation time of the granted license in RFC 3339 format.
entitlements GetReceivedLicenseEntitlement[]
License entitlements. Detailed below
homeRegion string
Home Region of the granted license.
id string
The provider-assigned unique ID for this managed resource.
issuers GetReceivedLicenseIssuer[]
Granted license issuer. Detailed below
licenseArn string
Amazon Resource Name (ARN) of the license.
licenseMetadatas GetReceivedLicenseLicenseMetadata[]
Granted license metadata. This is in the form of a set of all meta data. Detailed below
licenseName string
License name.
productName string
Product name.

  • product_sku - Product SKU.
productSku string
receivedMetadatas GetReceivedLicenseReceivedMetadata[]
Granted license received metadata. Detailed below
status string
Granted license status.
validities GetReceivedLicenseValidity[]
Date and time range during which the granted license is valid, in ISO8601-UTC format. Detailed below
version string
Version of the granted license.
beneficiary str
Granted license beneficiary. This is in the form of the ARN of the root user of the account.
consumption_configurations Sequence[GetReceivedLicenseConsumptionConfiguration]
Configuration for consumption of the license. Detailed below
create_time str
Creation time of the granted license in RFC 3339 format.
entitlements Sequence[GetReceivedLicenseEntitlement]
License entitlements. Detailed below
home_region str
Home Region of the granted license.
id str
The provider-assigned unique ID for this managed resource.
issuers Sequence[GetReceivedLicenseIssuer]
Granted license issuer. Detailed below
license_arn str
Amazon Resource Name (ARN) of the license.
license_metadatas Sequence[GetReceivedLicenseLicenseMetadata]
Granted license metadata. This is in the form of a set of all meta data. Detailed below
license_name str
License name.
product_name str
Product name.

  • product_sku - Product SKU.
product_sku str
received_metadatas Sequence[GetReceivedLicenseReceivedMetadata]
Granted license received metadata. Detailed below
status str
Granted license status.
validities Sequence[GetReceivedLicenseValidity]
Date and time range during which the granted license is valid, in ISO8601-UTC format. Detailed below
version str
Version of the granted license.
beneficiary String
Granted license beneficiary. This is in the form of the ARN of the root user of the account.
consumptionConfigurations List<Property Map>
Configuration for consumption of the license. Detailed below
createTime String
Creation time of the granted license in RFC 3339 format.
entitlements List<Property Map>
License entitlements. Detailed below
homeRegion String
Home Region of the granted license.
id String
The provider-assigned unique ID for this managed resource.
issuers List<Property Map>
Granted license issuer. Detailed below
licenseArn String
Amazon Resource Name (ARN) of the license.
licenseMetadatas List<Property Map>
Granted license metadata. This is in the form of a set of all meta data. Detailed below
licenseName String
License name.
productName String
Product name.

  • product_sku - Product SKU.
productSku String
receivedMetadatas List<Property Map>
Granted license received metadata. Detailed below
status String
Granted license status.
validities List<Property Map>
Date and time range during which the granted license is valid, in ISO8601-UTC format. Detailed below
version String
Version of the granted license.

Supporting Types

GetReceivedLicenseConsumptionConfiguration

BorrowConfigurations This property is required. List<GetReceivedLicenseConsumptionConfigurationBorrowConfiguration>
Details about a borrow configuration. Detailed below
ProvisionalConfigurations This property is required. List<GetReceivedLicenseConsumptionConfigurationProvisionalConfiguration>
Details about a provisional configuration. Detailed below
RenewType This property is required. string
BorrowConfigurations This property is required. []GetReceivedLicenseConsumptionConfigurationBorrowConfiguration
Details about a borrow configuration. Detailed below
ProvisionalConfigurations This property is required. []GetReceivedLicenseConsumptionConfigurationProvisionalConfiguration
Details about a provisional configuration. Detailed below
RenewType This property is required. string
borrowConfigurations This property is required. List<GetReceivedLicenseConsumptionConfigurationBorrowConfiguration>
Details about a borrow configuration. Detailed below
provisionalConfigurations This property is required. List<GetReceivedLicenseConsumptionConfigurationProvisionalConfiguration>
Details about a provisional configuration. Detailed below
renewType This property is required. String
borrowConfigurations This property is required. GetReceivedLicenseConsumptionConfigurationBorrowConfiguration[]
Details about a borrow configuration. Detailed below
provisionalConfigurations This property is required. GetReceivedLicenseConsumptionConfigurationProvisionalConfiguration[]
Details about a provisional configuration. Detailed below
renewType This property is required. string
borrow_configurations This property is required. Sequence[GetReceivedLicenseConsumptionConfigurationBorrowConfiguration]
Details about a borrow configuration. Detailed below
provisional_configurations This property is required. Sequence[GetReceivedLicenseConsumptionConfigurationProvisionalConfiguration]
Details about a provisional configuration. Detailed below
renew_type This property is required. str
borrowConfigurations This property is required. List<Property Map>
Details about a borrow configuration. Detailed below
provisionalConfigurations This property is required. List<Property Map>
Details about a provisional configuration. Detailed below
renewType This property is required. String

GetReceivedLicenseConsumptionConfigurationBorrowConfiguration

AllowEarlyCheckIn This property is required. bool
Indicates whether early check-ins are allowed.
MaxTimeToLiveInMinutes This property is required. int
Maximum time for the provisional configuration, in minutes.
AllowEarlyCheckIn This property is required. bool
Indicates whether early check-ins are allowed.
MaxTimeToLiveInMinutes This property is required. int
Maximum time for the provisional configuration, in minutes.
allowEarlyCheckIn This property is required. Boolean
Indicates whether early check-ins are allowed.
maxTimeToLiveInMinutes This property is required. Integer
Maximum time for the provisional configuration, in minutes.
allowEarlyCheckIn This property is required. boolean
Indicates whether early check-ins are allowed.
maxTimeToLiveInMinutes This property is required. number
Maximum time for the provisional configuration, in minutes.
allow_early_check_in This property is required. bool
Indicates whether early check-ins are allowed.
max_time_to_live_in_minutes This property is required. int
Maximum time for the provisional configuration, in minutes.
allowEarlyCheckIn This property is required. Boolean
Indicates whether early check-ins are allowed.
maxTimeToLiveInMinutes This property is required. Number
Maximum time for the provisional configuration, in minutes.

GetReceivedLicenseConsumptionConfigurationProvisionalConfiguration

MaxTimeToLiveInMinutes This property is required. int
Maximum time for the provisional configuration, in minutes.
MaxTimeToLiveInMinutes This property is required. int
Maximum time for the provisional configuration, in minutes.
maxTimeToLiveInMinutes This property is required. Integer
Maximum time for the provisional configuration, in minutes.
maxTimeToLiveInMinutes This property is required. number
Maximum time for the provisional configuration, in minutes.
max_time_to_live_in_minutes This property is required. int
Maximum time for the provisional configuration, in minutes.
maxTimeToLiveInMinutes This property is required. Number
Maximum time for the provisional configuration, in minutes.

GetReceivedLicenseEntitlement

AllowCheckIn This property is required. bool
Indicates whether check-ins are allowed.
MaxCount This property is required. int
Maximum entitlement count. Use if the unit is not None.
Name This property is required. string
The key name.
Overage This property is required. bool
Indicates whether overages are allowed.
Unit This property is required. string
Entitlement unit.
Value This property is required. string
The value.
AllowCheckIn This property is required. bool
Indicates whether check-ins are allowed.
MaxCount This property is required. int
Maximum entitlement count. Use if the unit is not None.
Name This property is required. string
The key name.
Overage This property is required. bool
Indicates whether overages are allowed.
Unit This property is required. string
Entitlement unit.
Value This property is required. string
The value.
allowCheckIn This property is required. Boolean
Indicates whether check-ins are allowed.
maxCount This property is required. Integer
Maximum entitlement count. Use if the unit is not None.
name This property is required. String
The key name.
overage This property is required. Boolean
Indicates whether overages are allowed.
unit This property is required. String
Entitlement unit.
value This property is required. String
The value.
allowCheckIn This property is required. boolean
Indicates whether check-ins are allowed.
maxCount This property is required. number
Maximum entitlement count. Use if the unit is not None.
name This property is required. string
The key name.
overage This property is required. boolean
Indicates whether overages are allowed.
unit This property is required. string
Entitlement unit.
value This property is required. string
The value.
allow_check_in This property is required. bool
Indicates whether check-ins are allowed.
max_count This property is required. int
Maximum entitlement count. Use if the unit is not None.
name This property is required. str
The key name.
overage This property is required. bool
Indicates whether overages are allowed.
unit This property is required. str
Entitlement unit.
value This property is required. str
The value.
allowCheckIn This property is required. Boolean
Indicates whether check-ins are allowed.
maxCount This property is required. Number
Maximum entitlement count. Use if the unit is not None.
name This property is required. String
The key name.
overage This property is required. Boolean
Indicates whether overages are allowed.
unit This property is required. String
Entitlement unit.
value This property is required. String
The value.

GetReceivedLicenseIssuer

KeyFingerprint This property is required. string
Issuer key fingerprint.
Name This property is required. string
The key name.
SignKey This property is required. string
Asymmetric KMS key from AWS Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
KeyFingerprint This property is required. string
Issuer key fingerprint.
Name This property is required. string
The key name.
SignKey This property is required. string
Asymmetric KMS key from AWS Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
keyFingerprint This property is required. String
Issuer key fingerprint.
name This property is required. String
The key name.
signKey This property is required. String
Asymmetric KMS key from AWS Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
keyFingerprint This property is required. string
Issuer key fingerprint.
name This property is required. string
The key name.
signKey This property is required. string
Asymmetric KMS key from AWS Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
key_fingerprint This property is required. str
Issuer key fingerprint.
name This property is required. str
The key name.
sign_key This property is required. str
Asymmetric KMS key from AWS Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
keyFingerprint This property is required. String
Issuer key fingerprint.
name This property is required. String
The key name.
signKey This property is required. String
Asymmetric KMS key from AWS Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

GetReceivedLicenseLicenseMetadata

Name This property is required. string
The key name.
Value This property is required. string
The value.
Name This property is required. string
The key name.
Value This property is required. string
The value.
name This property is required. String
The key name.
value This property is required. String
The value.
name This property is required. string
The key name.
value This property is required. string
The value.
name This property is required. str
The key name.
value This property is required. str
The value.
name This property is required. String
The key name.
value This property is required. String
The value.

GetReceivedLicenseReceivedMetadata

AllowedOperations This property is required. List<string>
A list of allowed operations.
ReceivedStatus This property is required. string
Received status.
ReceivedStatusReason This property is required. string
Received status reason.
AllowedOperations This property is required. []string
A list of allowed operations.
ReceivedStatus This property is required. string
Received status.
ReceivedStatusReason This property is required. string
Received status reason.
allowedOperations This property is required. List<String>
A list of allowed operations.
receivedStatus This property is required. String
Received status.
receivedStatusReason This property is required. String
Received status reason.
allowedOperations This property is required. string[]
A list of allowed operations.
receivedStatus This property is required. string
Received status.
receivedStatusReason This property is required. string
Received status reason.
allowed_operations This property is required. Sequence[str]
A list of allowed operations.
received_status This property is required. str
Received status.
received_status_reason This property is required. str
Received status reason.
allowedOperations This property is required. List<String>
A list of allowed operations.
receivedStatus This property is required. String
Received status.
receivedStatusReason This property is required. String
Received status reason.

GetReceivedLicenseValidity

Begin This property is required. string
Start of the validity time range.
End This property is required. string
End of the validity time range.
Begin This property is required. string
Start of the validity time range.
End This property is required. string
End of the validity time range.
begin This property is required. String
Start of the validity time range.
end This property is required. String
End of the validity time range.
begin This property is required. string
Start of the validity time range.
end This property is required. string
End of the validity time range.
begin This property is required. str
Start of the validity time range.
end This property is required. str
End of the validity time range.
begin This property is required. String
Start of the validity time range.
end This property is required. String
End of the validity time range.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.