ReportDefinition
The definition of AWS Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.
Contents
- AdditionalSchemaElements
-
A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
Type: Array of strings
Valid Values:
RESOURCES | SPLIT_COST_ALLOCATION_DATA | MANUAL_DISCOUNT_COMPATIBILITYRequired: Yes
- Compression
-
The compression format that AWS uses for the report.
If you choose
Parquetfor theCompression, you must also specifyParquetfor theFormatparameter.If you choose
ZIPorGZIPfor theCompression, you must specifytextORcsvfor theFormatparameter.Type: String
Valid Values:
ZIP | GZIP | ParquetRequired: Yes
- Format
-
The format that AWS saves the report in.
If you choose
Parquetfor theFormat, you must also specifyParquetfor theCompressionparameter.If you choose
textORcsvfor theFormat, you must specifyZIPorGZIPfor theCompressionparameter.Type: String
Valid Values:
textORcsv | ParquetRequired: Yes
- ReportName
-
The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
[0-9A-Za-z!\-_.*\'()]+Required: Yes
- S3Bucket
-
The S3 bucket where AWS delivers the report.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
[A-Za-z0-9_\.\-]+Required: Yes
- S3Prefix
-
The prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
[0-9A-Za-z!\-_.*\'()/]*Required: Yes
- S3Region
-
The region of the S3 bucket that AWS delivers the report into.
Type: String
Valid Values:
af-south-1 | ap-east-1 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | eu-central-1 | eu-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | eu-south-2 | me-central-1 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2 | cn-north-1 | cn-northwest-1Required: Yes
- TimeUnit
-
The length of time covered by the report.
Type: String
Valid Values:
HOURLY | DAILY | MONTHLYRequired: Yes
- AdditionalArtifacts
-
A list of manifests that you want AWS to create for this report.
Type: Array of strings
Valid Values:
REDSHIFT | QUICKSIGHT | ATHENARequired: No
- BillingViewArn
-
The Amazon resource name of the billing view. The
BillingViewArnis needed to create AWS Cost and Usage Report for each billing group maintained in the AWS Billing Conductor service. TheBillingViewArnfor a billing group can be constructed as:arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-idor retrieved by calling the ListBillingViews API.Type: String
Length Constraints: Maximum length of 128.
Pattern:
(arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\+=\.\-@].{1,30}Required: No
- RefreshClosedReports
-
Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months. These charges can include refunds, credits, or support fees.
Type: Boolean
Required: No
- ReportStatus
-
The status of the report.
Type: ReportStatus object
Required: No
- ReportVersioning
-
Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
Type: String
Valid Values:
CREATE_NEW_REPORT | OVERWRITE_REPORTRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
