ReportDefinition - AWS Cost Explorer Service
ContentsSee Also

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

AdditionalArtifacts

A list of manifests that you want Amazon Web Services to create for this report.

Type: Array of strings

Valid Values: REDSHIFT | QUICKSIGHT | ATHENA

Required: No

AdditionalSchemaElements

A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

Type: Array of strings

Valid Values: RESOURCES

Required: Yes

BillingViewArn

The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.

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

Compression

The compression format that AWS uses for the report.

Type: String

Valid Values: ZIP | GZIP | Parquet

Required: Yes

Format

The format that AWS saves the report in.

Type: String

Valid Values: textORcsv | Parquet

Required: Yes

RefreshClosedReports

Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

Type: Boolean

Required: No

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

ReportVersioning

Whether you want Amazon Web Services 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_REPORT

Required: No

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-southeast-1 | ap-southeast-2 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | eu-central-1 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2 | cn-north-1 | cn-northwest-1

Required: Yes

TimeUnit

The length of time covered by the report.

Type: String

Valid Values: HOURLY | DAILY | MONTHLY

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: