AWS CLI Command Reference

[ aws . license-manager ]

update-license-configuration

Description

Modifies the attributes of an existing license configuration.

See also: AWS API Documentation

Synopsis

  update-license-configuration
--license-configuration-arn <value>
[--license-configuration-status <value>]
[--license-rules <value>]
[--license-count <value>]
[--license-count-hard-limit | --no-license-count-hard-limit]
[--name <value>]
[--description <value>]
[--product-information-list <value>]
[--disassociate-when-not-found | --no-disassociate-when-not-found]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--license-configuration-arn (string)

Amazon Resource Name (ARN) of the license configuration.

--license-configuration-status (string)

New status of the license configuration.

Possible values:

  • AVAILABLE

  • DISABLED

--license-rules (list)

New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

(string)

Syntax:

"string" "string" ...

--license-count (long)

New number of licenses managed by the license configuration.

--license-count-hard-limit | --no-license-count-hard-limit (boolean)

New hard limit of the number of available licenses.

--name (string)

New name of the license configuration.

--description (string)

New description of the license configuration.

--product-information-list (list)

New product information.

(structure)

Describes product information for a license configuration.

ResourceType -> (string)

Resource type. The possible values are SSM_MANAGED | RDS .

ProductInformationFilterList -> (list)

A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator .

The following filters and 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 .

  • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key . ProductInformationFilterValue is optional if you are not using values for the key.

  • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_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.

JSON Syntax:

[
  {
    "ResourceType": "string",
    "ProductInformationFilterList": [
      {
        "ProductInformationFilterName": "string",
        "ProductInformationFilterValue": ["string", ...],
        "ProductInformationFilterComparator": "string"
      }
      ...
    ]
  }
  ...
]

--disassociate-when-not-found | --no-disassociate-when-not-found (boolean)

When true, disassociates a resource when software is uninstalled.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update a license configuration

The following update-license-configuration example updates the specified license configuration to remove the hard limit.

aws license-manager update-license-configuration \
    --no-license-count-hard-limit \
    --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE

This command produces no output.

The following update-license-configuration example updates the specified license configuration to change its status to DISABLED.

aws license-manager update-license-configuration \
    --license-configuration-status DISABLED
    --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE

This command produces no output.

Output

None

© Copyright 2018, Amazon Web Services. Created using Sphinx.