Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CostAndUsageReport.Types.ReportDefinition

Description

Synopsis

data ReportDefinition = ReportDefinition' {
- additionalArtifacts :: Maybe [AdditionalArtifact]
- billingViewArn :: Maybe Text
- refreshClosedReports :: Maybe Bool
- reportVersioning :: Maybe ReportVersioning
- reportName :: Text
- timeUnit :: TimeUnit
- format :: ReportFormat
- compression :: CompressionFormat
- additionalSchemaElements :: [SchemaElement]
- s3Bucket :: Text
- s3Prefix :: Text
- s3Region :: AWSRegion
}
newReportDefinition :: Text -> TimeUnit -> ReportFormat -> CompressionFormat -> Text -> Text -> AWSRegion -> ReportDefinition
reportDefinition_additionalArtifacts :: Lens' ReportDefinition (Maybe [AdditionalArtifact])
reportDefinition_billingViewArn :: Lens' ReportDefinition (Maybe Text)
reportDefinition_refreshClosedReports :: Lens' ReportDefinition (Maybe Bool)
reportDefinition_reportVersioning :: Lens' ReportDefinition (Maybe ReportVersioning)
reportDefinition_reportName :: Lens' ReportDefinition Text
reportDefinition_timeUnit :: Lens' ReportDefinition TimeUnit
reportDefinition_format :: Lens' ReportDefinition ReportFormat
reportDefinition_compression :: Lens' ReportDefinition CompressionFormat
reportDefinition_additionalSchemaElements :: Lens' ReportDefinition [SchemaElement]
reportDefinition_s3Bucket :: Lens' ReportDefinition Text
reportDefinition_s3Prefix :: Lens' ReportDefinition Text
reportDefinition_s3Region :: Lens' ReportDefinition AWSRegion

Documentation

data ReportDefinition Source #

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.

See: newReportDefinition smart constructor.

Constructors

ReportDefinition'

Fields

additionalArtifacts :: Maybe [AdditionalArtifact]
A list of manifests that you want Amazon Web Services to create for this report.
billingViewArn :: Maybe Text
The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.
refreshClosedReports :: Maybe Bool
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.
reportVersioning :: Maybe 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.
reportName :: Text
timeUnit :: TimeUnit
format :: ReportFormat
compression :: CompressionFormat
additionalSchemaElements :: [SchemaElement]
A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
s3Bucket :: Text
s3Prefix :: Text
s3Region :: AWSRegion

Instances

Instances details

FromJSON ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Methods parseJSON :: Value -> Parser ReportDefinition # parseJSONList :: Value -> Parser [ReportDefinition] #
ToJSON ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Methods toJSON :: ReportDefinition -> Value # toEncoding :: ReportDefinition -> Encoding # toJSONList :: [ReportDefinition] -> Value # toEncodingList :: [ReportDefinition] -> Encoding #
Generic ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Associated Types type Rep ReportDefinition :: Type -> Type # Methods from :: ReportDefinition -> Rep ReportDefinition x # to :: Rep ReportDefinition x -> ReportDefinition #
Read ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Methods readsPrec :: Int -> ReadS ReportDefinition # readList :: ReadS [ReportDefinition] # readPrec :: ReadPrec ReportDefinition # readListPrec :: ReadPrec [ReportDefinition] #
Show ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Methods showsPrec :: Int -> ReportDefinition -> ShowS # show :: ReportDefinition -> String # showList :: [ReportDefinition] -> ShowS #
NFData ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Methods rnf :: ReportDefinition -> () #
Eq ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Methods (==) :: ReportDefinition -> ReportDefinition -> Bool # (/=) :: ReportDefinition -> ReportDefinition -> Bool #
Hashable ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition Methods hashWithSalt :: Int -> ReportDefinition -> Int # hash :: ReportDefinition -> Int #
type Rep ReportDefinition Source #
Instance details Defined in Amazonka.CostAndUsageReport.Types.ReportDefinition type Rep ReportDefinition = D1 ('MetaData "ReportDefinition" "Amazonka.CostAndUsageReport.Types.ReportDefinition" "amazonka-cur-2.0-Ar4XU2SgG5LIUbbRiyuqiu" 'False) (C1 ('MetaCons "ReportDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdditionalArtifact])) :: (S1 ('MetaSel ('Just "billingViewArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "refreshClosedReports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "reportVersioning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportVersioning)) :: (S1 ('MetaSel ('Just "reportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "timeUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TimeUnit)))) :: ((S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReportFormat) :: (S1 ('MetaSel ('Just "compression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CompressionFormat) :: S1 ('MetaSel ('Just "additionalSchemaElements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SchemaElement]))) :: (S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AWSRegion))))))

newReportDefinition Source #

Arguments

:: Text	`$sel:reportName:ReportDefinition'`
-> TimeUnit	`$sel:timeUnit:ReportDefinition'`
-> ReportFormat	`$sel:format:ReportDefinition'`
-> CompressionFormat	`$sel:compression:ReportDefinition'`
-> Text	`$sel:s3Bucket:ReportDefinition'`
-> Text	`$sel:s3Prefix:ReportDefinition'`
-> AWSRegion	`$sel:s3Region:ReportDefinition'`
-> ReportDefinition

Create a value of ReportDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalArtifacts:ReportDefinition', reportDefinition_additionalArtifacts - A list of manifests that you want Amazon Web Services to create for this report.

$sel:billingViewArn:ReportDefinition', reportDefinition_billingViewArn - The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.

$sel:refreshClosedReports:ReportDefinition', reportDefinition_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.

$sel:reportVersioning:ReportDefinition', reportDefinition_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.

$sel:reportName:ReportDefinition', reportDefinition_reportName - Undocumented member.

$sel:timeUnit:ReportDefinition', reportDefinition_timeUnit - Undocumented member.

$sel:format:ReportDefinition', reportDefinition_format - Undocumented member.

$sel:compression:ReportDefinition', reportDefinition_compression - Undocumented member.

$sel:additionalSchemaElements:ReportDefinition', reportDefinition_additionalSchemaElements - A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

$sel:s3Bucket:ReportDefinition', reportDefinition_s3Bucket - Undocumented member.

$sel:s3Prefix:ReportDefinition', reportDefinition_s3Prefix - Undocumented member.

$sel:s3Region:ReportDefinition', reportDefinition_s3Region - Undocumented member.

reportDefinition_additionalArtifacts :: Lens' ReportDefinition (Maybe [AdditionalArtifact]) Source #

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

reportDefinition_billingViewArn :: Lens' ReportDefinition (Maybe Text) Source #

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

reportDefinition_refreshClosedReports :: Lens' ReportDefinition (Maybe Bool) Source #

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.

reportDefinition_reportVersioning :: Lens' ReportDefinition (Maybe ReportVersioning) Source #

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.

reportDefinition_reportName :: Lens' ReportDefinition Text Source #

Undocumented member.

reportDefinition_timeUnit :: Lens' ReportDefinition TimeUnit Source #

Undocumented member.

reportDefinition_format :: Lens' ReportDefinition ReportFormat Source #

Undocumented member.

reportDefinition_compression :: Lens' ReportDefinition CompressionFormat Source #

Undocumented member.

reportDefinition_additionalSchemaElements :: Lens' ReportDefinition [SchemaElement] Source #

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

reportDefinition_s3Bucket :: Lens' ReportDefinition Text Source #

Undocumented member.

reportDefinition_s3Prefix :: Lens' ReportDefinition Text Source #

Undocumented member.

reportDefinition_s3Region :: Lens' ReportDefinition AWSRegion Source #

Undocumented member.