[ aws . license-manager ]

create-license-manager-report-generator

Description

Creates a report generator.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-license-manager-report-generator
--report-generator-name <value>
--type <value>
--report-context <value>
--report-frequency <value>
--client-token <value>
[--description <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--report-generator-name (string)

Name of the report generator.

--type (list)

Type of reports to generate. The following report types an be generated:

  • License configuration report - Reports the number and details of consumed licenses for a license configuration.

  • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  LicenseConfigurationSummaryReport
  LicenseConfigurationUsageReport

--report-context (structure)

Defines the type of license configuration the report generator tracks.

licenseConfigurationArns -> (list)

Amazon Resource Name (ARN) of the license configuration that this generator reports on.

(string)

Shorthand Syntax:

licenseConfigurationArns=string,string

JSON Syntax:

{
  "licenseConfigurationArns": ["string", ...]
}

--report-frequency (structure)

Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.

value -> (integer)

Number of times within the frequency period that a report is generated. The only supported value is 1 .

period -> (string)

Time period between each report. The period can be daily, weekly, or monthly.

Shorthand Syntax:

value=integer,period=string

JSON Syntax:

{
  "value": integer,
  "period": "DAY"|"WEEK"|"MONTH"
}

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--description (string)

Description of the report generator.

--tags (list)

Tags to add to the report generator.

(structure)

Details about a tag for a license configuration.

Key -> (string)

Tag key.

Value -> (string)

Tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Output

LicenseManagerReportGeneratorArn -> (string)

The Amazon Resource Name (ARN) of the new report generator.