export_ecs_service_recommendations
async
¶
export_ecs_service_recommendations(
s3_destination_config: S3DestinationConfig,
*,
config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
account_ids: Optional[AccountIds] = None,
filters: Optional[ECSServiceRecommendationFilters] = None,
fields_to_export: Optional[ExportableECSServiceFields] = None,
file_format: Optional[FileFormat] = None,
include_member_accounts: Optional[IncludeMemberAccounts] = None,
) -> ExportECSServiceRecommendationsResponse
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.
Parameters:
-
account_ids(Optional[AccountIds], default:None) –The Amazon Web Services account IDs for the export Amazon 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.
-
filters(Optional[ECSServiceRecommendationFilters], default:None) –An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.
-
fields_to_export(Optional[ExportableECSServiceFields], default:None) –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.
-
file_format(Optional[FileFormat], default:None) –The format of the export file.
The CSV file is the only export file format currently supported.
-
include_member_accounts(Optional[IncludeMemberAccounts], default:None) –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.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
InternalServerException–An internal error has occurred. Try your call again.
-
InvalidParameterValueException–The value supplied for the input parameter is out of range or not valid.
-
LimitExceededException–The request exceeds a limit of the service.
-
MissingAuthenticationToken–The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
-
OptInRequiredException–The account is not opted in to Compute Optimizer.
-
ServiceUnavailableException–The request has failed due to a temporary failure of the server.
-
ThrottlingException–The request was denied due to request throttling.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_compute_optimizer/_services/async_compute_optimizer.py
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 | |