[ aws . license-manager ]

get-license-configuration

Description

Gets detailed information about the specified license configuration.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-license-configuration
--license-configuration-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--license-configuration-arn (string)

Amazon Resource Name (ARN) of the license configuration.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get license configuration information

The following get-license-configuration example displays details for the specified license configuration.

aws license-manager get-license-configuration \
    --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE

Output:

{
    "LicenseConfigurationId": "lic-38b658717b87478aaa7c00883EXAMPLE",
    "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE",
    "Name": "my-license-configuration",
    "LicenseCountingType": "vCPU",
    "LicenseRules": [],
    "LicenseCountHardLimit": false,
    "ConsumedLicenses": 0,
    "Status": "AVAILABLE",
    "OwnerAccountId": "123456789012",
    "ConsumedLicenseSummaryList": [
        {
            "ResourceType": "EC2_INSTANCE",
            "ConsumedLicenses": 0
        },
        {
            "ResourceType": "EC2_HOST",
            "ConsumedLicenses": 0
        },
        {
            "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE",
            "ConsumedLicenses": 0
        }
    ],
    "ManagedResourceSummaryList": [
        {
            "ResourceType": "EC2_INSTANCE",
            "AssociationCount": 0
        },
        {
            "ResourceType": "EC2_HOST",
            "AssociationCount": 0
        },
        {
            "ResourceType": "EC2_AMI",
            "AssociationCount": 2
        },
        {
            "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE",
            "AssociationCount": 0
        }
    ]
}

Output

LicenseConfigurationId -> (string)

Unique ID for the license configuration.

LicenseConfigurationArn -> (string)

Amazon Resource Name (ARN) of the license configuration.

Name -> (string)

Name of the license configuration.

Description -> (string)

Description of the license configuration.

LicenseCountingType -> (string)

Dimension on which the licenses are counted.

LicenseRules -> (list)

License rules.

(string)

LicenseCount -> (long)

Number of available licenses.

LicenseCountHardLimit -> (boolean)

Sets the number of available licenses as a hard limit.

ConsumedLicenses -> (long)

Number of licenses assigned to resources.

Status -> (string)

License configuration status.

OwnerAccountId -> (string)

Account ID of the owner of the license configuration.

ConsumedLicenseSummaryList -> (list)

Summaries of the licenses consumed by resources.

(structure)

Details about license consumption.

ResourceType -> (string)

Resource type of the resource consuming a license.

ConsumedLicenses -> (long)

Number of licenses consumed by the resource.

ManagedResourceSummaryList -> (list)

Summaries of the managed resources.

(structure)

Summary information about a managed resource.

ResourceType -> (string)

Type of resource associated with a license.

AssociationCount -> (long)

Number of resources associated with licenses.

Tags -> (list)

Tags for the license configuration.

(structure)

Details about a tag for a license configuration.

Key -> (string)

Tag key.

Value -> (string)

Tag value.

ProductInformationList -> (list)

Product information.

(structure)

Describes product information for a license configuration.

ResourceType -> (string)

Resource type. The possible values are SSM_MANAGED | RDS .

ProductInformationFilterList -> (list)

Product information filters.

The following filters and logical operators are supported when the resource type is SSM_MANAGED :

• Application Name - The name of the application. Logical operator is EQUALS .

• Application Publisher - The publisher of the application. Logical operator is EQUALS .

• Application Version - The version of the application. Logical operator is EQUALS .

• Platform Name - The name of the platform. Logical operator is EQUALS .

• Platform Type - The platform type. Logical operator is EQUALS .

• License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .

The following filters and logical operators are supported when the resource type is RDS :

• Engine Edition - The edition of the database engine. Logical operator is EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 .

• License Pack - The license pack. Logical operator is EQUALS . Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap .

(structure)

Describes product information filters.

ProductInformationFilterName -> (string)

Filter name.

ProductInformationFilterValue -> (list)

Filter value.

(string)

ProductInformationFilterComparator -> (string)

Logical operator.

AutomatedDiscoveryInformation -> (structure)

Automated discovery information.

LastRunTime -> (timestamp)

Time that automated discovery last ran.

DisassociateWhenNotFound -> (boolean)

When true, disassociates a resource when software is uninstalled.