| 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.ComputeOptimizer.ExportECSServiceRecommendations
Description
Exports optimization recommendations for Amazon ECS services on Fargate.
Recommendations are exported in a CSV file, and its metadata in a JSON file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can only have one Amazon ECS service export job in progress per Amazon Web Services Region.
Synopsis
- data ExportECSServiceRecommendations = ExportECSServiceRecommendations' {}
- newExportECSServiceRecommendations :: S3DestinationConfig -> ExportECSServiceRecommendations
- exportECSServiceRecommendations_accountIds :: Lens' ExportECSServiceRecommendations (Maybe [Text])
- exportECSServiceRecommendations_fieldsToExport :: Lens' ExportECSServiceRecommendations (Maybe [ExportableECSServiceField])
- exportECSServiceRecommendations_fileFormat :: Lens' ExportECSServiceRecommendations (Maybe FileFormat)
- exportECSServiceRecommendations_filters :: Lens' ExportECSServiceRecommendations (Maybe [ECSServiceRecommendationFilter])
- exportECSServiceRecommendations_includeMemberAccounts :: Lens' ExportECSServiceRecommendations (Maybe Bool)
- exportECSServiceRecommendations_s3DestinationConfig :: Lens' ExportECSServiceRecommendations S3DestinationConfig
- data ExportECSServiceRecommendationsResponse = ExportECSServiceRecommendationsResponse' {}
- newExportECSServiceRecommendationsResponse :: Int -> ExportECSServiceRecommendationsResponse
- exportECSServiceRecommendationsResponse_jobId :: Lens' ExportECSServiceRecommendationsResponse (Maybe Text)
- exportECSServiceRecommendationsResponse_s3Destination :: Lens' ExportECSServiceRecommendationsResponse (Maybe S3Destination)
- exportECSServiceRecommendationsResponse_httpStatus :: Lens' ExportECSServiceRecommendationsResponse Int
Creating a Request
data ExportECSServiceRecommendations Source #
See: newExportECSServiceRecommendations smart constructor.
Constructors
| ExportECSServiceRecommendations' | |
Fields
| |
Instances
newExportECSServiceRecommendations Source #
Arguments
| :: S3DestinationConfig | |
| -> ExportECSServiceRecommendations |
Create a value of ExportECSServiceRecommendations 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:accountIds:ExportECSServiceRecommendations', exportECSServiceRecommendations_accountIds - The Amazon Web Services account IDs for the export ECS service
recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
$sel:fieldsToExport:ExportECSServiceRecommendations', exportECSServiceRecommendations_fieldsToExport - The recommendations data to include in the export file. For more
information about the fields that can be exported, see
Exported files
in the Compute Optimizer User Guide.
$sel:fileFormat:ExportECSServiceRecommendations', exportECSServiceRecommendations_fileFormat - The format of the export file.
The CSV file is the only export file format currently supported.
$sel:filters:ExportECSServiceRecommendations', exportECSServiceRecommendations_filters - An array of objects to specify a filter that exports a more specific set
of ECS service recommendations.
$sel:includeMemberAccounts:ExportECSServiceRecommendations', exportECSServiceRecommendations_includeMemberAccounts - If your account is the management account or the delegated administrator
of an organization, this parameter indicates whether to include
recommendations for resources in all member accounts of the
organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
$sel:s3DestinationConfig:ExportECSServiceRecommendations', exportECSServiceRecommendations_s3DestinationConfig - Undocumented member.
Request Lenses
exportECSServiceRecommendations_accountIds :: Lens' ExportECSServiceRecommendations (Maybe [Text]) Source #
The Amazon Web Services account IDs for the export ECS service recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
exportECSServiceRecommendations_fieldsToExport :: Lens' ExportECSServiceRecommendations (Maybe [ExportableECSServiceField]) Source #
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
exportECSServiceRecommendations_fileFormat :: Lens' ExportECSServiceRecommendations (Maybe FileFormat) Source #
The format of the export file.
The CSV file is the only export file format currently supported.
exportECSServiceRecommendations_filters :: Lens' ExportECSServiceRecommendations (Maybe [ECSServiceRecommendationFilter]) Source #
An array of objects to specify a filter that exports a more specific set of ECS service recommendations.
exportECSServiceRecommendations_includeMemberAccounts :: Lens' ExportECSServiceRecommendations (Maybe Bool) Source #
If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
exportECSServiceRecommendations_s3DestinationConfig :: Lens' ExportECSServiceRecommendations S3DestinationConfig Source #
Undocumented member.
Destructuring the Response
data ExportECSServiceRecommendationsResponse Source #
See: newExportECSServiceRecommendationsResponse smart constructor.
Constructors
| ExportECSServiceRecommendationsResponse' | |
Fields
| |
Instances
newExportECSServiceRecommendationsResponse Source #
Arguments
| :: Int | |
| -> ExportECSServiceRecommendationsResponse |
Create a value of ExportECSServiceRecommendationsResponse 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:
ExportECSServiceRecommendationsResponse, exportECSServiceRecommendationsResponse_jobId - The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
$sel:s3Destination:ExportECSServiceRecommendationsResponse', exportECSServiceRecommendationsResponse_s3Destination - Undocumented member.
$sel:httpStatus:ExportECSServiceRecommendationsResponse', exportECSServiceRecommendationsResponse_httpStatus - The response's http status code.
Response Lenses
exportECSServiceRecommendationsResponse_jobId :: Lens' ExportECSServiceRecommendationsResponse (Maybe Text) Source #
The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
exportECSServiceRecommendationsResponse_s3Destination :: Lens' ExportECSServiceRecommendationsResponse (Maybe S3Destination) Source #
Undocumented member.
exportECSServiceRecommendationsResponse_httpStatus :: Lens' ExportECSServiceRecommendationsResponse Int Source #
The response's http status code.