aws_sdk_computeoptimizer/client/
export_lambda_function_recommendations.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ExportLambdaFunctionRecommendations`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`account_ids(impl Into<String>)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::account_ids) / [`set_account_ids(Option<Vec::<String>>)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::set_account_ids):<br>required: **false**<br><p>The IDs of the Amazon Web Services accounts for which to export Lambda function recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.</p> <p>This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.</p> <p>You can specify multiple account IDs per request.</p><br>
7    ///   - [`filters(LambdaFunctionRecommendationFilter)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::filters) / [`set_filters(Option<Vec::<LambdaFunctionRecommendationFilter>>)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.</p><br>
8    ///   - [`fields_to_export(ExportableLambdaFunctionField)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::fields_to_export) / [`set_fields_to_export(Option<Vec::<ExportableLambdaFunctionField>>)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::set_fields_to_export):<br>required: **false**<br><p>The recommendations data to include in the export file. For more information about the fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User Guide</i>.</p><br>
9    ///   - [`s3_destination_config(S3DestinationConfig)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::s3_destination_config) / [`set_s3_destination_config(Option<S3DestinationConfig>)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::set_s3_destination_config):<br>required: **true**<br><p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.</p> <p>You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html">Amazon S3 Bucket Policy for Compute Optimizer</a> in the <i>Compute Optimizer User Guide</i>.</p><br>
10    ///   - [`file_format(FileFormat)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::file_format) / [`set_file_format(Option<FileFormat>)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::set_file_format):<br>required: **false**<br><p>The format of the export file.</p> <p>The only export file format currently supported is <code>Csv</code>.</p><br>
11    ///   - [`include_member_accounts(bool)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::include_member_accounts) / [`set_include_member_accounts(Option<bool>)`](crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::set_include_member_accounts):<br>required: **false**<br><p>Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.</p> <p>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 <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access">Compute Optimizer and Amazon Web Services Organizations trusted access</a> in the <i>Compute Optimizer User Guide</i>.</p> <p>Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.</p> <p>This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.</p><br>
12    /// - On success, responds with [`ExportLambdaFunctionRecommendationsOutput`](crate::operation::export_lambda_function_recommendations::ExportLambdaFunctionRecommendationsOutput) with field(s):
13    ///   - [`job_id(Option<String>)`](crate::operation::export_lambda_function_recommendations::ExportLambdaFunctionRecommendationsOutput::job_id): <p>The identification number of the export job.</p> <p>Use the <code>DescribeRecommendationExportJobs</code> action, and specify the job ID to view the status of an export job.</p>
14    ///   - [`s3_destination(Option<S3Destination>)`](crate::operation::export_lambda_function_recommendations::ExportLambdaFunctionRecommendationsOutput::s3_destination): <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.</p>
15    /// - On failure, responds with [`SdkError<ExportLambdaFunctionRecommendationsError>`](crate::operation::export_lambda_function_recommendations::ExportLambdaFunctionRecommendationsError)
16    pub fn export_lambda_function_recommendations(
17        &self,
18    ) -> crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder {
19        crate::operation::export_lambda_function_recommendations::builders::ExportLambdaFunctionRecommendationsFluentBuilder::new(self.handle.clone())
20    }
21}