Creates a report generator.
Request Syntax
{
"ClientToken": "string",
"Description": "string",
"ReportContext": {
"licenseConfigurationArns": [ "string" ]
},
"ReportFrequency": {
"period": "string",
"value": number
},
"ReportGeneratorName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Type": [ "string" ]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: Yes
- Description
-
Description of the report generator.
Type: String
Required: No
- ReportContext
-
Defines the type of license configuration the report generator tracks.
Type: ReportContext object
Required: Yes
- ReportFrequency
-
Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.
Type: ReportFrequency object
Required: Yes
- ReportGeneratorName
-
Name of the report generator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- Tags
-
Tags to add to the report generator.
Type: Array of Tag objects
Required: No
- Type
-
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.
Type: Array of strings
Valid Values:
LicenseConfigurationSummaryReport | LicenseConfigurationUsageReportRequired: Yes
-
Response Syntax
{
"LicenseManagerReportGeneratorArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LicenseManagerReportGeneratorArn
-
The Amazon Resource Name (ARN) of the new report generator.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to resource denied.
HTTP Status Code: 400
- AuthorizationException
-
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400
- InvalidParameterValueException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- RateLimitExceededException
-
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400
- ResourceLimitExceededException
-
Your resource limits have been exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource cannot be found.
HTTP Status Code: 400
- ServerInternalException
-
The server experienced an internal error. Try again.
HTTP Status Code: 500
- ValidationException
-
The provided input is not valid. Try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
