| 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.ApplicationCostProfiler
Description
Derived from API version 2020-09-10 of the AWS service descriptions, licensed under Apache 2.0.
This reference provides descriptions of the AWS Application Cost Profiler API.
The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete application cost report definitions, as well as to import your usage data into the Application Cost Profiler service.
For more information about using this service, see the AWS Application Cost Profiler User Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data DeleteReportDefinition = DeleteReportDefinition' Text
- newDeleteReportDefinition :: Text -> DeleteReportDefinition
- data DeleteReportDefinitionResponse = DeleteReportDefinitionResponse' (Maybe Text) Int
- newDeleteReportDefinitionResponse :: Int -> DeleteReportDefinitionResponse
- data GetReportDefinition = GetReportDefinition' Text
- newGetReportDefinition :: Text -> GetReportDefinition
- data GetReportDefinitionResponse = GetReportDefinitionResponse' Int Text Text ReportFrequency Format S3Location POSIX POSIX
- newGetReportDefinitionResponse :: Int -> Text -> Text -> ReportFrequency -> Format -> S3Location -> UTCTime -> UTCTime -> GetReportDefinitionResponse
- data ImportApplicationUsage = ImportApplicationUsage' SourceS3Location
- newImportApplicationUsage :: SourceS3Location -> ImportApplicationUsage
- data ImportApplicationUsageResponse = ImportApplicationUsageResponse' Int Text
- newImportApplicationUsageResponse :: Int -> Text -> ImportApplicationUsageResponse
- data ListReportDefinitions = ListReportDefinitions' (Maybe Natural) (Maybe Text)
- newListReportDefinitions :: ListReportDefinitions
- data ListReportDefinitionsResponse = ListReportDefinitionsResponse' (Maybe Text) (Maybe [ReportDefinition]) Int
- newListReportDefinitionsResponse :: Int -> ListReportDefinitionsResponse
- data PutReportDefinition = PutReportDefinition' Text Text ReportFrequency Format S3Location
- newPutReportDefinition :: Text -> Text -> ReportFrequency -> Format -> S3Location -> PutReportDefinition
- data PutReportDefinitionResponse = PutReportDefinitionResponse' (Maybe Text) Int
- newPutReportDefinitionResponse :: Int -> PutReportDefinitionResponse
- data UpdateReportDefinition = UpdateReportDefinition' Text Text ReportFrequency Format S3Location
- newUpdateReportDefinition :: Text -> Text -> ReportFrequency -> Format -> S3Location -> UpdateReportDefinition
- data UpdateReportDefinitionResponse = UpdateReportDefinitionResponse' (Maybe Text) Int
- newUpdateReportDefinitionResponse :: Int -> UpdateReportDefinitionResponse
- newtype Format where
- Format' {
- fromFormat :: Text
- pattern Format_CSV :: Format
- pattern Format_PARQUET :: Format
- Format' {
- newtype ReportFrequency where
- ReportFrequency' { }
- pattern ReportFrequency_ALL :: ReportFrequency
- pattern ReportFrequency_DAILY :: ReportFrequency
- pattern ReportFrequency_MONTHLY :: ReportFrequency
- newtype S3BucketRegion where
- S3BucketRegion' { }
- pattern S3BucketRegion_Af_south_1 :: S3BucketRegion
- pattern S3BucketRegion_Ap_east_1 :: S3BucketRegion
- pattern S3BucketRegion_Eu_south_1 :: S3BucketRegion
- pattern S3BucketRegion_Me_south_1 :: S3BucketRegion
- data ReportDefinition = ReportDefinition' (Maybe POSIX) (Maybe S3Location) (Maybe Format) (Maybe POSIX) (Maybe Text) (Maybe ReportFrequency) (Maybe Text)
- newReportDefinition :: ReportDefinition
- data S3Location = S3Location' Text Text
- newS3Location :: Text -> Text -> S3Location
- data SourceS3Location = SourceS3Location' (Maybe S3BucketRegion) Text Text
- newSourceS3Location :: Text -> Text -> SourceS3Location
Service Configuration
defaultService :: Service Source #
API version 2020-09-10 of the Amazon Application Cost Profiler SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ApplicationCostProfiler.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have permission to perform this action.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal server error occurred. Retry your request.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Your request exceeds one or more of the service quotas.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The calls to AWS Application Cost Profiler API are throttled. The request was denied.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints for the API.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteReportDefinition
data DeleteReportDefinition Source #
See: newDeleteReportDefinition smart constructor.
Constructors
| DeleteReportDefinition' Text |
Instances
newDeleteReportDefinition Source #
Arguments
| :: Text | |
| -> DeleteReportDefinition |
Create a value of DeleteReportDefinition 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:
DeleteReportDefinition, deleteReportDefinition_reportId - Required. ID of the report to delete.
data DeleteReportDefinitionResponse Source #
See: newDeleteReportDefinitionResponse smart constructor.
Constructors
| DeleteReportDefinitionResponse' (Maybe Text) Int |
Instances
newDeleteReportDefinitionResponse Source #
Create a value of DeleteReportDefinitionResponse 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:
DeleteReportDefinition, deleteReportDefinitionResponse_reportId - ID of the report that was deleted.
$sel:httpStatus:DeleteReportDefinitionResponse', deleteReportDefinitionResponse_httpStatus - The response's http status code.
GetReportDefinition
data GetReportDefinition Source #
See: newGetReportDefinition smart constructor.
Constructors
| GetReportDefinition' Text |
Instances
newGetReportDefinition Source #
Arguments
| :: Text | |
| -> GetReportDefinition |
Create a value of GetReportDefinition 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:
GetReportDefinition, getReportDefinition_reportId - ID of the report to retrieve.
data GetReportDefinitionResponse Source #
See: newGetReportDefinitionResponse smart constructor.
Constructors
| GetReportDefinitionResponse' Int Text Text ReportFrequency Format S3Location POSIX POSIX |
Instances
newGetReportDefinitionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> ReportFrequency | |
| -> Format | |
| -> S3Location | |
| -> UTCTime | |
| -> UTCTime | |
| -> GetReportDefinitionResponse |
Create a value of GetReportDefinitionResponse 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:httpStatus:GetReportDefinitionResponse', getReportDefinitionResponse_httpStatus - The response's http status code.
GetReportDefinition, getReportDefinitionResponse_reportId - ID of the report retrieved.
GetReportDefinitionResponse, getReportDefinitionResponse_reportDescription - Description of the report.
GetReportDefinitionResponse, getReportDefinitionResponse_reportFrequency - Cadence used to generate the report.
GetReportDefinitionResponse, getReportDefinitionResponse_format - Format of the generated report.
GetReportDefinitionResponse, getReportDefinitionResponse_destinationS3Location - Amazon Simple Storage Service (Amazon S3) location where the report is
uploaded.
GetReportDefinitionResponse, getReportDefinitionResponse_createdAt - Timestamp (milliseconds) when this report definition was created.
$sel:lastUpdated:GetReportDefinitionResponse', getReportDefinitionResponse_lastUpdated - Timestamp (milliseconds) when this report definition was last updated.
ImportApplicationUsage
data ImportApplicationUsage Source #
See: newImportApplicationUsage smart constructor.
Constructors
| ImportApplicationUsage' SourceS3Location |
Instances
newImportApplicationUsage Source #
Create a value of ImportApplicationUsage 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:sourceS3Location:ImportApplicationUsage', importApplicationUsage_sourceS3Location - Amazon S3 location to import application usage data from.
data ImportApplicationUsageResponse Source #
See: newImportApplicationUsageResponse smart constructor.
Constructors
| ImportApplicationUsageResponse' Int Text |
Instances
newImportApplicationUsageResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> ImportApplicationUsageResponse |
Create a value of ImportApplicationUsageResponse 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:httpStatus:ImportApplicationUsageResponse', importApplicationUsageResponse_httpStatus - The response's http status code.
$sel:importId:ImportApplicationUsageResponse', importApplicationUsageResponse_importId - ID of the import request.
ListReportDefinitions (Paginated)
data ListReportDefinitions Source #
See: newListReportDefinitions smart constructor.
Constructors
| ListReportDefinitions' (Maybe Natural) (Maybe Text) |
Instances
newListReportDefinitions :: ListReportDefinitions Source #
Create a value of ListReportDefinitions 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:maxResults:ListReportDefinitions', listReportDefinitions_maxResults - The maximum number of results to return.
ListReportDefinitions, listReportDefinitions_nextToken - The token value from a previous call to access the next page of results.
data ListReportDefinitionsResponse Source #
See: newListReportDefinitionsResponse smart constructor.
Constructors
| ListReportDefinitionsResponse' (Maybe Text) (Maybe [ReportDefinition]) Int |
Instances
newListReportDefinitionsResponse Source #
Create a value of ListReportDefinitionsResponse 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:
ListReportDefinitions, listReportDefinitionsResponse_nextToken - The value of the next token, if it exists. Null if there are no more
results.
$sel:reportDefinitions:ListReportDefinitionsResponse', listReportDefinitionsResponse_reportDefinitions - The retrieved reports.
$sel:httpStatus:ListReportDefinitionsResponse', listReportDefinitionsResponse_httpStatus - The response's http status code.
PutReportDefinition
data PutReportDefinition Source #
See: newPutReportDefinition smart constructor.
Constructors
| PutReportDefinition' Text Text ReportFrequency Format S3Location |
Instances
newPutReportDefinition Source #
Arguments
| :: Text | |
| -> Text | |
| -> ReportFrequency | |
| -> Format | |
| -> S3Location | |
| -> PutReportDefinition |
Create a value of PutReportDefinition 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:
PutReportDefinition, putReportDefinition_reportId - Required. ID of the report. You can choose any valid string matching the
pattern for the ID.
PutReportDefinition, putReportDefinition_reportDescription - Required. Description of the report.
PutReportDefinition, putReportDefinition_reportFrequency - Required. The cadence to generate the report.
PutReportDefinition, putReportDefinition_format - Required. The format to use for the generated report.
PutReportDefinition, putReportDefinition_destinationS3Location - Required. Amazon Simple Storage Service (Amazon S3) location where
Application Cost Profiler uploads the report.
data PutReportDefinitionResponse Source #
See: newPutReportDefinitionResponse smart constructor.
Constructors
| PutReportDefinitionResponse' (Maybe Text) Int |
Instances
newPutReportDefinitionResponse Source #
Create a value of PutReportDefinitionResponse 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:
PutReportDefinition, putReportDefinitionResponse_reportId - ID of the report.
$sel:httpStatus:PutReportDefinitionResponse', putReportDefinitionResponse_httpStatus - The response's http status code.
UpdateReportDefinition
data UpdateReportDefinition Source #
See: newUpdateReportDefinition smart constructor.
Constructors
| UpdateReportDefinition' Text Text ReportFrequency Format S3Location |
Instances
newUpdateReportDefinition Source #
Arguments
| :: Text | |
| -> Text | |
| -> ReportFrequency | |
| -> Format | |
| -> S3Location | |
| -> UpdateReportDefinition |
Create a value of UpdateReportDefinition 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:
UpdateReportDefinition, updateReportDefinition_reportId - Required. ID of the report to update.
UpdateReportDefinition, updateReportDefinition_reportDescription - Required. Description of the report.
UpdateReportDefinition, updateReportDefinition_reportFrequency - Required. The cadence to generate the report.
UpdateReportDefinition, updateReportDefinition_format - Required. The format to use for the generated report.
UpdateReportDefinition, updateReportDefinition_destinationS3Location - Required. Amazon Simple Storage Service (Amazon S3) location where
Application Cost Profiler uploads the report.
data UpdateReportDefinitionResponse Source #
See: newUpdateReportDefinitionResponse smart constructor.
Constructors
| UpdateReportDefinitionResponse' (Maybe Text) Int |
Instances
newUpdateReportDefinitionResponse Source #
Create a value of UpdateReportDefinitionResponse 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:
UpdateReportDefinition, updateReportDefinitionResponse_reportId - ID of the report.
$sel:httpStatus:UpdateReportDefinitionResponse', updateReportDefinitionResponse_httpStatus - The response's http status code.
Types
Format
Constructors
| Format' | |
Fields
| |
Bundled Patterns
| pattern Format_CSV :: Format | |
| pattern Format_PARQUET :: Format |
Instances
ReportFrequency
newtype ReportFrequency Source #
Constructors
| ReportFrequency' | |
Fields | |
Bundled Patterns
| pattern ReportFrequency_ALL :: ReportFrequency | |
| pattern ReportFrequency_DAILY :: ReportFrequency | |
| pattern ReportFrequency_MONTHLY :: ReportFrequency |
Instances
S3BucketRegion
newtype S3BucketRegion Source #
Constructors
| S3BucketRegion' | |
Fields | |
Bundled Patterns
| pattern S3BucketRegion_Af_south_1 :: S3BucketRegion | |
| pattern S3BucketRegion_Ap_east_1 :: S3BucketRegion | |
| pattern S3BucketRegion_Eu_south_1 :: S3BucketRegion | |
| pattern S3BucketRegion_Me_south_1 :: S3BucketRegion |
Instances
ReportDefinition
data ReportDefinition Source #
The configuration of a report in AWS Application Cost Profiler.
See: newReportDefinition smart constructor.
Constructors
| ReportDefinition' (Maybe POSIX) (Maybe S3Location) (Maybe Format) (Maybe POSIX) (Maybe Text) (Maybe ReportFrequency) (Maybe Text) |
Instances
newReportDefinition :: ReportDefinition Source #
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:createdAt:ReportDefinition', reportDefinition_createdAt - Timestamp (milliseconds) when this report definition was created.
$sel:destinationS3Location:ReportDefinition', reportDefinition_destinationS3Location - The location in Amazon Simple Storage Service (Amazon S3) the reports
should be saved to.
$sel:format:ReportDefinition', reportDefinition_format - The format used for the generated reports.
$sel:lastUpdatedAt:ReportDefinition', reportDefinition_lastUpdatedAt - Timestamp (milliseconds) when this report definition was last updated.
$sel:reportDescription:ReportDefinition', reportDefinition_reportDescription - Description of the report
$sel:reportFrequency:ReportDefinition', reportDefinition_reportFrequency - The cadence at which the report is generated.
$sel:reportId:ReportDefinition', reportDefinition_reportId - The ID of the report.
S3Location
data S3Location Source #
Represents the Amazon Simple Storage Service (Amazon S3) location where AWS Application Cost Profiler reports are generated and then written to.
See: newS3Location smart constructor.
Constructors
| S3Location' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> S3Location |
Create a value of S3Location 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:bucket:S3Location', s3Location_bucket - Name of the S3 bucket.
$sel:prefix:S3Location', s3Location_prefix - Prefix for the location to write to.
SourceS3Location
data SourceS3Location Source #
Represents the Amazon Simple Storage Service (Amazon S3) location where usage data is read from.
See: newSourceS3Location smart constructor.
Constructors
| SourceS3Location' (Maybe S3BucketRegion) Text Text |
Instances
Create a value of SourceS3Location 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:region:SourceS3Location', sourceS3Location_region - Region of the bucket. Only required for Regions that are disabled by
default. For more infomration about Regions that are disabled by
default, see
Enabling a Region
in the AWS General Reference guide.
$sel:bucket:SourceS3Location', sourceS3Location_bucket - Name of the bucket.
$sel:key:SourceS3Location', sourceS3Location_key - Key of the object.