1. Packages
  2. AWS Classic
  3. API Docs
  4. licensemanager
  5. getReceivedLicense

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi

aws.licensemanager.getReceivedLicense

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi

    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.

    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",
        });
    
    });
    
    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
    	})
    }
    
    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());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.licensemanager.get_received_license(license_arn="arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0")
    
    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",
    });
    
    variables:
      test:
        fn::invoke:
          Function: aws:licensemanager:getReceivedLicense
          Arguments:
            licenseArn: arn:aws:license-manager::111111111111:license:l-ecbaa94eb71a4830b6d7e49268fecaa0
    

    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>
    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]
    func GetReceivedLicense(ctx *Context, args *GetReceivedLicenseArgs, opts ...InvokeOption) (*GetReceivedLicenseResult, error)
    func GetReceivedLicenseOutput(ctx *Context, args *GetReceivedLicenseOutputArgs, opts ...InvokeOption) GetReceivedLicenseResultOutput

    > 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)
    }
    public static CompletableFuture<GetReceivedLicenseResult> getReceivedLicense(GetReceivedLicenseArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:licensemanager/getReceivedLicense:getReceivedLicense
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LicenseArn string

    The ARN of the received license you want data for.

    LicenseArn string

    The ARN of the received license you want data for.

    licenseArn String

    The ARN of the received license you want data for.

    licenseArn string

    The ARN of the received license you want data for.

    license_arn str

    The ARN of the received license you want data for.

    licenseArn 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 List<Property Map>

    Details about a borrow configuration. Detailed below

    provisionalConfigurations List<Property Map>

    Details about a provisional configuration. Detailed below

    renewType String

    GetReceivedLicenseConsumptionConfigurationBorrowConfiguration

    AllowEarlyCheckIn bool

    Indicates whether early check-ins are allowed.

    MaxTimeToLiveInMinutes int

    Maximum time for the provisional configuration, in minutes.

    AllowEarlyCheckIn bool

    Indicates whether early check-ins are allowed.

    MaxTimeToLiveInMinutes int

    Maximum time for the provisional configuration, in minutes.

    allowEarlyCheckIn Boolean

    Indicates whether early check-ins are allowed.

    maxTimeToLiveInMinutes Integer

    Maximum time for the provisional configuration, in minutes.

    allowEarlyCheckIn boolean

    Indicates whether early check-ins are allowed.

    maxTimeToLiveInMinutes number

    Maximum time for the provisional configuration, in minutes.

    allow_early_check_in bool

    Indicates whether early check-ins are allowed.

    max_time_to_live_in_minutes int

    Maximum time for the provisional configuration, in minutes.

    allowEarlyCheckIn Boolean

    Indicates whether early check-ins are allowed.

    maxTimeToLiveInMinutes Number

    Maximum time for the provisional configuration, in minutes.

    GetReceivedLicenseConsumptionConfigurationProvisionalConfiguration

    MaxTimeToLiveInMinutes int

    Maximum time for the provisional configuration, in minutes.

    MaxTimeToLiveInMinutes int

    Maximum time for the provisional configuration, in minutes.

    maxTimeToLiveInMinutes Integer

    Maximum time for the provisional configuration, in minutes.

    maxTimeToLiveInMinutes number

    Maximum time for the provisional configuration, in minutes.

    max_time_to_live_in_minutes int

    Maximum time for the provisional configuration, in minutes.

    maxTimeToLiveInMinutes Number

    Maximum time for the provisional configuration, in minutes.

    GetReceivedLicenseEntitlement

    AllowCheckIn bool

    Indicates whether check-ins are allowed.

    MaxCount int

    Maximum entitlement count. Use if the unit is not None.

    Name string

    The key name.

    Unit string

    Entitlement unit.

    Value string

    The value.

    AllowCheckIn bool

    Indicates whether check-ins are allowed.

    MaxCount int

    Maximum entitlement count. Use if the unit is not None.

    Name string

    The key name.

    Unit string

    Entitlement unit.

    Value string

    The value.

    allowCheckIn Boolean

    Indicates whether check-ins are allowed.

    maxCount Integer

    Maximum entitlement count. Use if the unit is not None.

    name String

    The key name.

    unit String

    Entitlement unit.

    value String

    The value.

    allowCheckIn boolean

    Indicates whether check-ins are allowed.

    maxCount number

    Maximum entitlement count. Use if the unit is not None.

    name string

    The key name.

    unit string

    Entitlement unit.

    value string

    The value.

    allow_check_in bool

    Indicates whether check-ins are allowed.

    max_count int

    Maximum entitlement count. Use if the unit is not None.

    name str

    The key name.

    unit str

    Entitlement unit.

    value str

    The value.

    allowCheckIn Boolean

    Indicates whether check-ins are allowed.

    maxCount Number

    Maximum entitlement count. Use if the unit is not None.

    name String

    The key name.

    unit String

    Entitlement unit.

    value String

    The value.

    GetReceivedLicenseIssuer

    KeyFingerprint string

    Issuer key fingerprint.

    Name string

    The key name.

    SignKey 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 string

    Issuer key fingerprint.

    Name string

    The key name.

    SignKey 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 String

    Issuer key fingerprint.

    name String

    The key name.

    signKey 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 string

    Issuer key fingerprint.

    name string

    The key name.

    signKey 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 str

    Issuer key fingerprint.

    name str

    The key name.

    sign_key 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 String

    Issuer key fingerprint.

    name String

    The key name.

    signKey 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 string

    The key name.

    Value string

    The value.

    Name string

    The key name.

    Value string

    The value.

    name String

    The key name.

    value String

    The value.

    name string

    The key name.

    value string

    The value.

    name str

    The key name.

    value str

    The value.

    name String

    The key name.

    value String

    The value.

    GetReceivedLicenseReceivedMetadata

    AllowedOperations List<string>

    A list of allowed operations.

    ReceivedStatus string

    Received status.

    ReceivedStatusReason string

    Received status reason.

    AllowedOperations []string

    A list of allowed operations.

    ReceivedStatus string

    Received status.

    ReceivedStatusReason string

    Received status reason.

    allowedOperations List<String>

    A list of allowed operations.

    receivedStatus String

    Received status.

    receivedStatusReason String

    Received status reason.

    allowedOperations string[]

    A list of allowed operations.

    receivedStatus string

    Received status.

    receivedStatusReason string

    Received status reason.

    allowed_operations Sequence[str]

    A list of allowed operations.

    received_status str

    Received status.

    received_status_reason str

    Received status reason.

    allowedOperations List<String>

    A list of allowed operations.

    receivedStatus String

    Received status.

    receivedStatusReason String

    Received status reason.

    GetReceivedLicenseValidity

    Begin string

    Start of the validity time range.

    End string

    End of the validity time range.

    Begin string

    Start of the validity time range.

    End string

    End of the validity time range.

    begin String

    Start of the validity time range.

    end String

    End of the validity time range.

    begin string

    Start of the validity time range.

    end string

    End of the validity time range.

    begin str

    Start of the validity time range.

    end str

    End of the validity time range.

    begin String

    Start of the validity time range.

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

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi