Class: Aws::CostandUsageReportService::Types::ReportDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb

Overview

The definition of Amazon Web Services 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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_artifacts ⇒ Array<String>

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

Returns:

  • (Array<String>) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#additional_schema_elements ⇒ Array<String>

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

Returns:

  • (Array<String>) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#billing_view_arn ⇒ String

The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#compression ⇒ String

The compression format that Amazon Web Services uses for the report.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format that Amazon Web Services saves the report in.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_closed_reports ⇒ Boolean

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.

Returns:

  • (Boolean) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#report_name ⇒ String

The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#report_status ⇒ Types::ReportStatus

The status of the report.

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#report_versioning ⇒ String

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.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket ⇒ String

The S3 bucket where Amazon Web Services delivers the report.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#s3_prefix ⇒ String

The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can't include spaces.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#s3_region ⇒ String

The region of the S3 bucket that Amazon Web Services delivers the report into.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end

#time_unit ⇒ String

The length of time covered by the report.

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 267

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning,
  :billing_view_arn,
  :report_status)
  SENSITIVE = []
  include Aws::Structure
end