[ aws . license-manager ]

get-service-settings

Description

Gets the License Manager settings for the current Region.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-service-settings
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get the License Manager settings

The following get-service-settings example displays the service settings for License Manager in the current Region.

aws license-manager get-service-settings

The following shows example output if cross-account resource discovery is disabled.

{
    "OrganizationConfiguration": {
        "EnableIntegration": false
    },
    "EnableCrossAccountsDiscovery": false
}

The following shows example output if cross-account resource discovery is enabled.

{
    "S3BucketArn": "arn:aws:s3:::aws-license-manager-service-c22d6279-35c4-47c4-bb",
    "OrganizationConfiguration": {
        "EnableIntegration": true
    },
    "EnableCrossAccountsDiscovery": true
}

Output

S3BucketArn -> (string)

Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.

SnsTopicArn -> (string)

SNS topic configured to receive notifications from License Manager.

OrganizationConfiguration -> (structure)

Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery.

EnableIntegration -> (boolean)

Enables AWS Organization integration.

EnableCrossAccountsDiscovery -> (boolean)

Indicates whether cross-account discovery has been enabled.

LicenseManagerResourceShareArn -> (string)

Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account will provide member accounts with access to this share.