Struct aws_sdk_computeoptimizer::Client

pub struct Client { /* private fields */ }

Client for AWS Compute Optimizer

Client for invoking operations on AWS Compute Optimizer. Each operation on AWS Compute Optimizer is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_computeoptimizer::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_computeoptimizer::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DeleteRecommendationPreferences operation has a Client::delete_recommendation_preferences, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.delete_recommendation_preferences()
    .resource_type("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn delete_recommendation_preferences( &self ) -> DeleteRecommendationPreferencesFluentBuilder

Constructs a fluent builder for the DeleteRecommendationPreferences operation.

• The fluent builder is configurable:
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):

    The target resource type of the recommendation preference to delete.

    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

    The valid values for this parameter are Ec2Instance and AutoScalingGroup.

  • scope(Scope) / set_scope(Option<Scope>):

    An object that describes the scope of the recommendation preference to delete.

    You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

  • recommendation_preference_names(RecommendationPreferenceName) / set_recommendation_preference_names(Option<Vec<RecommendationPreferenceName>>):

    The name of the recommendation preference to delete.

• On success, responds with DeleteRecommendationPreferencesOutput
• On failure, responds with SdkError<DeleteRecommendationPreferencesError>

impl Client

pub fn describe_recommendation_export_jobs( &self ) -> DescribeRecommendationExportJobsFluentBuilder

Constructs a fluent builder for the DescribeRecommendationExportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • job_ids(impl Into<String>) / set_job_ids(Option<Vec<String>>):

    The identification numbers of the export jobs to return.

    An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.

    All export jobs created in the last seven days are returned if this parameter is omitted.

  • filters(JobFilter) / set_filters(Option<Vec<JobFilter>>):

    An array of objects to specify a filter that returns a more specific list of export jobs.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of export jobs.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of export jobs to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

• On success, responds with DescribeRecommendationExportJobsOutput with field(s):
  • recommendation_export_jobs(Option<Vec<RecommendationExportJob>>):

    An array of objects that describe recommendation export jobs.

  • next_token(Option<String>):

    The token to use to advance to the next page of export jobs.

    This value is null when there are no more pages of export jobs to return.

• On failure, responds with SdkError<DescribeRecommendationExportJobsError>

impl Client

pub fn export_auto_scaling_group_recommendations( &self ) -> ExportAutoScalingGroupRecommendationsFluentBuilder

Constructs a fluent builder for the ExportAutoScalingGroupRecommendations operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The IDs of the Amazon Web Services accounts for which to export Auto Scaling group recommendations.

    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.

    This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

    Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

    You can specify multiple account IDs per request.

  • filters(Filter) / set_filters(Option<Vec<Filter>>):

    An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.

  • fields_to_export(ExportableAutoScalingGroupField) / set_fields_to_export(Option<Vec<ExportableAutoScalingGroupField>>):

    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.

  • s3_destination_config(S3DestinationConfig) / set_s3_destination_config(Option<S3DestinationConfig>):

    An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

    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 permissions 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 Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

  • file_format(FileFormat) / set_file_format(Option<FileFormat>):

    The format of the export file.

    The only export file format currently supported is Csv.

  • include_member_accounts(bool) / set_include_member_accounts(Option<bool>):

    Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an 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.

    Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

    This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

    Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

  • recommendation_preferences(RecommendationPreferences) / set_recommendation_preferences(Option<RecommendationPreferences>):

    An object to specify the preferences for the Auto Scaling group recommendations to export.

• On success, responds with ExportAutoScalingGroupRecommendationsOutput with field(s):
  • job_id(Option<String>):

    The identification number of the export job.

    Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

  • s3_destination(Option<S3Destination>):

    An object that describes the destination Amazon S3 bucket of a recommendations export file.

• On failure, responds with SdkError<ExportAutoScalingGroupRecommendationsError>

impl Client

pub fn export_ebs_volume_recommendations( &self ) -> ExportEBSVolumeRecommendationsFluentBuilder

Constructs a fluent builder for the ExportEBSVolumeRecommendations operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.

    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.

    This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

    Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

    You can specify multiple account IDs per request.

  • filters(EbsFilter) / set_filters(Option<Vec<EbsFilter>>):

    An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

  • fields_to_export(ExportableVolumeField) / set_fields_to_export(Option<Vec<ExportableVolumeField>>):

    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.

  • s3_destination_config(S3DestinationConfig) / set_s3_destination_config(Option<S3DestinationConfig>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.

    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 Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

  • file_format(FileFormat) / set_file_format(Option<FileFormat>):

    The format of the export file.

    The only export file format currently supported is Csv.

  • include_member_accounts(bool) / set_include_member_accounts(Option<bool>):

    Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an 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.

    Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

    This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

    Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

• On success, responds with ExportEbsVolumeRecommendationsOutput with field(s):
  • job_id(Option<String>):

    The identification number of the export job.

    Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

  • s3_destination(Option<S3Destination>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

• On failure, responds with SdkError<ExportEBSVolumeRecommendationsError>

impl Client

pub fn export_ec2_instance_recommendations( &self ) -> ExportEC2InstanceRecommendationsFluentBuilder

Constructs a fluent builder for the ExportEC2InstanceRecommendations operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The IDs of the Amazon Web Services accounts for which to export instance recommendations.

    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.

    This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

    Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

    You can specify multiple account IDs per request.

  • filters(Filter) / set_filters(Option<Vec<Filter>>):

    An array of objects to specify a filter that exports a more specific set of instance recommendations.

  • fields_to_export(ExportableInstanceField) / set_fields_to_export(Option<Vec<ExportableInstanceField>>):

    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.

  • s3_destination_config(S3DestinationConfig) / set_s3_destination_config(Option<S3DestinationConfig>):

    An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

    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 permissions 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 Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

  • file_format(FileFormat) / set_file_format(Option<FileFormat>):

    The format of the export file.

    The only export file format currently supported is Csv.

  • include_member_accounts(bool) / set_include_member_accounts(Option<bool>):

    Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an 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.

    Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

    Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

  • recommendation_preferences(RecommendationPreferences) / set_recommendation_preferences(Option<RecommendationPreferences>):

    An object to specify the preferences for the Amazon EC2 instance recommendations to export.

• On success, responds with ExportEc2InstanceRecommendationsOutput with field(s):
  • job_id(Option<String>):

    The identification number of the export job.

    Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

  • s3_destination(Option<S3Destination>):

    An object that describes the destination Amazon S3 bucket of a recommendations export file.

• On failure, responds with SdkError<ExportEC2InstanceRecommendationsError>

impl Client

pub fn export_ecs_service_recommendations( &self ) -> ExportECSServiceRecommendationsFluentBuilder

Constructs a fluent builder for the ExportECSServiceRecommendations operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    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(EcsServiceRecommendationFilter) / set_filters(Option<Vec<EcsServiceRecommendationFilter>>):

    An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.

  • fields_to_export(ExportableEcsServiceField) / set_fields_to_export(Option<Vec<ExportableEcsServiceField>>):

    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.

  • s3_destination_config(S3DestinationConfig) / set_s3_destination_config(Option<S3DestinationConfig>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.

    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 Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

  • file_format(FileFormat) / set_file_format(Option<FileFormat>):

    The format of the export file.

    The CSV file is the only export file format currently supported.

  • include_member_accounts(bool) / set_include_member_accounts(Option<bool>):

    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.

• On success, responds with ExportEcsServiceRecommendationsOutput with field(s):
  • job_id(Option<String>):

    The identification number of the export job.

    To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.

  • s3_destination(Option<S3Destination>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

• On failure, responds with SdkError<ExportECSServiceRecommendationsError>

impl Client

pub fn export_lambda_function_recommendations( &self ) -> ExportLambdaFunctionRecommendationsFluentBuilder

Constructs a fluent builder for the ExportLambdaFunctionRecommendations operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The IDs of the Amazon Web Services accounts for which to export Lambda function recommendations.

    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.

    This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

    Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

    You can specify multiple account IDs per request.

  • filters(LambdaFunctionRecommendationFilter) / set_filters(Option<Vec<LambdaFunctionRecommendationFilter>>):

    An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.

  • fields_to_export(ExportableLambdaFunctionField) / set_fields_to_export(Option<Vec<ExportableLambdaFunctionField>>):

    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.

  • s3_destination_config(S3DestinationConfig) / set_s3_destination_config(Option<S3DestinationConfig>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.

    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 Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

  • file_format(FileFormat) / set_file_format(Option<FileFormat>):

    The format of the export file.

    The only export file format currently supported is Csv.

  • include_member_accounts(bool) / set_include_member_accounts(Option<bool>):

    Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an 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.

    Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

    This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

    Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

• On success, responds with ExportLambdaFunctionRecommendationsOutput with field(s):
  • job_id(Option<String>):

    The identification number of the export job.

    Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

  • s3_destination(Option<S3Destination>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

• On failure, responds with SdkError<ExportLambdaFunctionRecommendationsError>

impl Client

pub fn export_license_recommendations( &self ) -> ExportLicenseRecommendationsFluentBuilder

Constructs a fluent builder for the ExportLicenseRecommendations operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The IDs of the Amazon Web Services accounts for which to export license recommendations.

    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.

    This parameter can’t be specified together with the include member accounts parameter. The parameters are mutually exclusive.

    If this parameter is omitted, recommendations for member accounts aren’t included in the export.

    You can specify multiple account IDs per request.

  • filters(LicenseRecommendationFilter) / set_filters(Option<Vec<LicenseRecommendationFilter>>):

    An array of objects to specify a filter that exports a more specific set of license recommendations.

  • fields_to_export(ExportableLicenseField) / set_fields_to_export(Option<Vec<ExportableLicenseField>>):

    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.

  • s3_destination_config(S3DestinationConfig) / set_s3_destination_config(Option<S3DestinationConfig>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.

    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 Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

  • file_format(FileFormat) / set_file_format(Option<FileFormat>):

    The format of the export file.

    A CSV file is the only export format currently supported.

  • include_member_accounts(bool) / set_include_member_accounts(Option<bool>):

    Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an 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 .

    This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

• On success, responds with ExportLicenseRecommendationsOutput with field(s):
  • job_id(Option<String>):

    The identification number of the export job.

    To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.

  • s3_destination(Option<S3Destination>):

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

• On failure, responds with SdkError<ExportLicenseRecommendationsError>

impl Client

pub fn get_auto_scaling_group_recommendations( &self ) -> GetAutoScalingGroupRecommendationsFluentBuilder

Constructs a fluent builder for the GetAutoScalingGroupRecommendations operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The ID of the Amazon Web Services account for which to return Auto Scaling group recommendations.

    If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.

    Only one account ID can be specified per request.

  • auto_scaling_group_arns(impl Into<String>) / set_auto_scaling_group_arns(Option<Vec<String>>):

    The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of Auto Scaling group recommendations.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of Auto Scaling group recommendations to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

  • filters(Filter) / set_filters(Option<Vec<Filter>>):

    An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

  • recommendation_preferences(RecommendationPreferences) / set_recommendation_preferences(Option<RecommendationPreferences>):

    An object to specify the preferences for the Auto Scaling group recommendations to return in the response.

• On success, responds with GetAutoScalingGroupRecommendationsOutput with field(s):
  • next_token(Option<String>):

    The token to use to advance to the next page of Auto Scaling group recommendations.

    This value is null when there are no more pages of Auto Scaling group recommendations to return.

  • auto_scaling_group_recommendations(Option<Vec<AutoScalingGroupRecommendation>>):

    An array of objects that describe Auto Scaling group recommendations.

  • errors(Option<Vec<GetRecommendationError>>):

    An array of objects that describe errors of the request.

    For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.

• On failure, responds with SdkError<GetAutoScalingGroupRecommendationsError>

impl Client

pub fn get_ebs_volume_recommendations( &self ) -> GetEBSVolumeRecommendationsFluentBuilder

Constructs a fluent builder for the GetEBSVolumeRecommendations operation.

• The fluent builder is configurable:
  • volume_arns(impl Into<String>) / set_volume_arns(Option<Vec<String>>):

    The Amazon Resource Name (ARN) of the volumes for which to return recommendations.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of volume recommendations.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of volume recommendations to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

  • filters(EbsFilter) / set_filters(Option<Vec<EbsFilter>>):

    An array of objects to specify a filter that returns a more specific list of volume recommendations.

  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The ID of the Amazon Web Services account for which to return volume recommendations.

    If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.

    Only one account ID can be specified per request.

• On success, responds with GetEbsVolumeRecommendationsOutput with field(s):
  • next_token(Option<String>):

    The token to use to advance to the next page of volume recommendations.

    This value is null when there are no more pages of volume recommendations to return.

  • volume_recommendations(Option<Vec<VolumeRecommendation>>):

    An array of objects that describe volume recommendations.

  • errors(Option<Vec<GetRecommendationError>>):

    An array of objects that describe errors of the request.

    For example, an error is returned if you request recommendations for an unsupported volume.

• On failure, responds with SdkError<GetEBSVolumeRecommendationsError>

impl Client

pub fn get_ec2_instance_recommendations( &self ) -> GetEC2InstanceRecommendationsFluentBuilder

Constructs a fluent builder for the GetEC2InstanceRecommendations operation.

• The fluent builder is configurable:
  • instance_arns(impl Into<String>) / set_instance_arns(Option<Vec<String>>):

    The Amazon Resource Name (ARN) of the instances for which to return recommendations.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of instance recommendations.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of instance recommendations to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

  • filters(Filter) / set_filters(Option<Vec<Filter>>):

    An array of objects to specify a filter that returns a more specific list of instance recommendations.

  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The ID of the Amazon Web Services account for which to return instance recommendations.

    If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.

    Only one account ID can be specified per request.

  • recommendation_preferences(RecommendationPreferences) / set_recommendation_preferences(Option<RecommendationPreferences>):

    An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.

• On success, responds with GetEc2InstanceRecommendationsOutput with field(s):
  • next_token(Option<String>):

    The token to use to advance to the next page of instance recommendations.

    This value is null when there are no more pages of instance recommendations to return.

  • instance_recommendations(Option<Vec<InstanceRecommendation>>):

    An array of objects that describe instance recommendations.

  • errors(Option<Vec<GetRecommendationError>>):

    An array of objects that describe errors of the request.

    For example, an error is returned if you request recommendations for an instance of an unsupported instance family.

• On failure, responds with SdkError<GetEC2InstanceRecommendationsError>

impl Client

pub fn get_ec2_recommendation_projected_metrics( &self ) -> GetEC2RecommendationProjectedMetricsFluentBuilder

Constructs a fluent builder for the GetEC2RecommendationProjectedMetrics operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.

  • stat(MetricStatistic) / set_stat(Option<MetricStatistic>):

    The statistic of the projected metrics.

  • period(i32) / set_period(Option<i32>):

    The granularity, in seconds, of the projected metrics data points.

  • start_time(DateTime) / set_start_time(Option<DateTime>):

    The timestamp of the first projected metrics data point to return.

  • end_time(DateTime) / set_end_time(Option<DateTime>):

    The timestamp of the last projected metrics data point to return.

  • recommendation_preferences(RecommendationPreferences) / set_recommendation_preferences(Option<RecommendationPreferences>):

    An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.

• On success, responds with GetEc2RecommendationProjectedMetricsOutput with field(s):
  • recommended_option_projected_metrics(Option<Vec<RecommendedOptionProjectedMetric>>):

    An array of objects that describes projected metrics.

• On failure, responds with SdkError<GetEC2RecommendationProjectedMetricsError>

impl Client

pub fn get_ecs_service_recommendation_projected_metrics( &self ) -> GetECSServiceRecommendationProjectedMetricsFluentBuilder

Constructs a fluent builder for the GetECSServiceRecommendationProjectedMetrics operation.

• The fluent builder is configurable:
  • service_arn(impl Into<String>) / set_service_arn(Option<String>):

    The ARN that identifies the Amazon ECS service.

    The following is the format of the ARN:

    arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

  • stat(MetricStatistic) / set_stat(Option<MetricStatistic>):

    The statistic of the projected metrics.

  • period(i32) / set_period(Option<i32>):

    The granularity, in seconds, of the projected metrics data points.

  • start_time(DateTime) / set_start_time(Option<DateTime>):

    The timestamp of the first projected metrics data point to return.

  • end_time(DateTime) / set_end_time(Option<DateTime>):

    The timestamp of the last projected metrics data point to return.

• On success, responds with GetEcsServiceRecommendationProjectedMetricsOutput with field(s):
  • recommended_option_projected_metrics(Option<Vec<EcsServiceRecommendedOptionProjectedMetric>>):

    An array of objects that describes the projected metrics.

• On failure, responds with SdkError<GetECSServiceRecommendationProjectedMetricsError>

impl Client

pub fn get_ecs_service_recommendations( &self ) -> GetECSServiceRecommendationsFluentBuilder

Constructs a fluent builder for the GetECSServiceRecommendations operation.

• The fluent builder is configurable:
  • service_arns(impl Into<String>) / set_service_arns(Option<Vec<String>>):

    The ARN that identifies the Amazon ECS service.

    The following is the format of the ARN:

    arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of Amazon ECS service recommendations.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of Amazon ECS service recommendations to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

  • filters(EcsServiceRecommendationFilter) / set_filters(Option<Vec<EcsServiceRecommendationFilter>>):

    An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations.

  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs.

    If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts.

    You can only specify one account ID per request.

• On success, responds with GetEcsServiceRecommendationsOutput with field(s):
  • next_token(Option<String>):

    The token to advance to the next page of Amazon ECS service recommendations.

  • ecs_service_recommendations(Option<Vec<EcsServiceRecommendation>>):

    An array of objects that describe the Amazon ECS service recommendations.

  • errors(Option<Vec<GetRecommendationError>>):

    An array of objects that describe errors of the request.

• On failure, responds with SdkError<GetECSServiceRecommendationsError>

impl Client

pub fn get_effective_recommendation_preferences( &self ) -> GetEffectiveRecommendationPreferencesFluentBuilder

Constructs a fluent builder for the GetEffectiveRecommendationPreferences operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.

• On success, responds with GetEffectiveRecommendationPreferencesOutput with field(s):
  • enhanced_infrastructure_metrics(Option<EnhancedInfrastructureMetrics>):

    The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.

    A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it’s not yet applied to recommendations.

    To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

    For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

  • external_metrics_preference(Option<ExternalMetricsPreference>):

    The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.

    If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn’t applied to the recommendations already, then this object doesn’t appear in the response.

    To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetEC2InstanceRecommendations actions.

    For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

• On failure, responds with SdkError<GetEffectiveRecommendationPreferencesError>

impl Client

pub fn get_enrollment_status(&self) -> GetEnrollmentStatusFluentBuilder

Constructs a fluent builder for the GetEnrollmentStatus operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetEnrollmentStatusOutput with field(s):
  • status(Option<Status>):

    The enrollment status of the account.

  • status_reason(Option<String>):

    The reason for the enrollment status of the account.

    For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

  • member_accounts_enrolled(bool):

    Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.

  • last_updated_timestamp(Option<DateTime>):

    The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

  • number_of_member_accounts_opted_in(Option<i32>):

    The count of organization member accounts that are opted in to the service, if your account is an organization management account.

• On failure, responds with SdkError<GetEnrollmentStatusError>

impl Client

pub fn get_enrollment_statuses_for_organization( &self ) -> GetEnrollmentStatusesForOrganizationFluentBuilder

Constructs a fluent builder for the GetEnrollmentStatusesForOrganization operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(EnrollmentFilter) / set_filters(Option<Vec<EnrollmentFilter>>):

    An array of objects to specify a filter that returns a more specific list of account enrollment statuses.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of account enrollment statuses.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.

    To retrieve the remaining results, make another request with the returned nextToken value.

• On success, responds with GetEnrollmentStatusesForOrganizationOutput with field(s):
  • account_enrollment_statuses(Option<Vec<AccountEnrollmentStatus>>):

    An array of objects that describe the enrollment statuses of organization member accounts.

  • next_token(Option<String>):

    The token to use to advance to the next page of account enrollment statuses.

    This value is null when there are no more pages of account enrollment statuses to return.

• On failure, responds with SdkError<GetEnrollmentStatusesForOrganizationError>

impl Client

pub fn get_lambda_function_recommendations( &self ) -> GetLambdaFunctionRecommendationsFluentBuilder

Constructs a fluent builder for the GetLambdaFunctionRecommendations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • function_arns(impl Into<String>) / set_function_arns(Option<Vec<String>>):

    The Amazon Resource Name (ARN) of the functions for which to return recommendations.

    You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest ($LATEST) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the Lambda Developer Guide.

  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The ID of the Amazon Web Services account for which to return function recommendations.

    If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations.

    Only one account ID can be specified per request.

  • filters(LambdaFunctionRecommendationFilter) / set_filters(Option<Vec<LambdaFunctionRecommendationFilter>>):

    An array of objects to specify a filter that returns a more specific list of function recommendations.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of function recommendations.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of function recommendations to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

• On success, responds with GetLambdaFunctionRecommendationsOutput with field(s):
  • next_token(Option<String>):

    The token to use to advance to the next page of function recommendations.

    This value is null when there are no more pages of function recommendations to return.

  • lambda_function_recommendations(Option<Vec<LambdaFunctionRecommendation>>):

    An array of objects that describe function recommendations.

• On failure, responds with SdkError<GetLambdaFunctionRecommendationsError>

impl Client

pub fn get_license_recommendations( &self ) -> GetLicenseRecommendationsFluentBuilder

Constructs a fluent builder for the GetLicenseRecommendations operation.

• The fluent builder is configurable:
  • resource_arns(impl Into<String>) / set_resource_arns(Option<Vec<String>>):

    The ARN that identifies the Amazon EC2 instance.

    The following is the format of the ARN:

    arn:aws:ec2:region:aws_account_id:instance/instance-id

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of license recommendations.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of license recommendations to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

  • filters(LicenseRecommendationFilter) / set_filters(Option<Vec<LicenseRecommendationFilter>>):

    An array of objects to specify a filter that returns a more specific list of license recommendations.

  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The ID of the Amazon Web Services account for which to return license recommendations.

    If your account is the management account of an organization, use this parameter to specify the member account for which you want to return license recommendations.

    Only one account ID can be specified per request.

• On success, responds with GetLicenseRecommendationsOutput with field(s):
  • next_token(Option<String>):

    The token to use to advance to the next page of license recommendations.

  • license_recommendations(Option<Vec<LicenseRecommendation>>):

    An array of objects that describe license recommendations.

  • errors(Option<Vec<GetRecommendationError>>):

    An array of objects that describe errors of the request.

• On failure, responds with SdkError<GetLicenseRecommendationsError>

impl Client

pub fn get_recommendation_preferences( &self ) -> GetRecommendationPreferencesFluentBuilder

Constructs a fluent builder for the GetRecommendationPreferences operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):

    The target resource type of the recommendation preference for which to return preferences.

    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

    The valid values for this parameter are Ec2Instance and AutoScalingGroup.

  • scope(Scope) / set_scope(Option<Scope>):

    An object that describes the scope of the recommendation preference to return.

    You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of recommendation preferences.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of recommendation preferences to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

• On success, responds with GetRecommendationPreferencesOutput with field(s):
  • next_token(Option<String>):

    The token to use to advance to the next page of recommendation preferences.

    This value is null when there are no more pages of recommendation preferences to return.

  • recommendation_preferences_details(Option<Vec<RecommendationPreferencesDetail>>):

    An array of objects that describe recommendation preferences.

• On failure, responds with SdkError<GetRecommendationPreferencesError>

impl Client

pub fn get_recommendation_summaries( &self ) -> GetRecommendationSummariesFluentBuilder

Constructs a fluent builder for the GetRecommendationSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec<String>>):

    The ID of the Amazon Web Services account for which to return recommendation summaries.

    If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.

    Only one account ID can be specified per request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token to advance to the next page of recommendation summaries.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of recommendation summaries to return with a single request.

    To retrieve the remaining results, make another request with the returned nextToken value.

• On success, responds with GetRecommendationSummariesOutput with field(s):
  • next_token(Option<String>):

    The token to use to advance to the next page of recommendation summaries.

    This value is null when there are no more pages of recommendation summaries to return.

  • recommendation_summaries(Option<Vec<RecommendationSummary>>):

    An array of objects that summarize a recommendation.

• On failure, responds with SdkError<GetRecommendationSummariesError>

impl Client

pub fn put_recommendation_preferences( &self ) -> PutRecommendationPreferencesFluentBuilder

Constructs a fluent builder for the PutRecommendationPreferences operation.

• The fluent builder is configurable:
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):

    The target resource type of the recommendation preference to create.

    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

    The valid values for this parameter are Ec2Instance and AutoScalingGroup.

  • scope(Scope) / set_scope(Option<Scope>):

    An object that describes the scope of the recommendation preference to create.

    You can create recommendation preferences at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

    You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

  • enhanced_infrastructure_metrics(EnhancedInfrastructureMetrics) / set_enhanced_infrastructure_metrics(Option<EnhancedInfrastructureMetrics>):

    The status of the enhanced infrastructure metrics recommendation preference to create or update.

    Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.

    For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

  • inferred_workload_types(InferredWorkloadTypesPreference) / set_inferred_workload_types(Option<InferredWorkloadTypesPreference>):

    The status of the inferred workload types recommendation preference to create or update.

    The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

    Specify the Inactive status to deactivate the feature, or specify Active to activate it.

    For more information, see Inferred workload types in the Compute Optimizer User Guide.

  • external_metrics_preference(ExternalMetricsPreference) / set_external_metrics_preference(Option<ExternalMetricsPreference>):

    The provider of the external metrics recommendation preference to create or update.

    Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.

    This preference can only be set for the Ec2Instance resource type.

    For more information, see External metrics ingestion in the Compute Optimizer User Guide.

• On success, responds with PutRecommendationPreferencesOutput
• On failure, responds with SdkError<PutRecommendationPreferencesError>

impl Client

pub fn update_enrollment_status(&self) -> UpdateEnrollmentStatusFluentBuilder

Constructs a fluent builder for the UpdateEnrollmentStatus operation.

• The fluent builder is configurable:
  • status(Status) / set_status(Option<Status>):

    The new enrollment status of the account.

    The following status options are available:

    • Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.

    • Inactive - Opts out your account from the Compute Optimizer service. Your account’s recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.

    The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.

  • include_member_accounts(bool) / set_include_member_accounts(Option<bool>):

    Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.

• On success, responds with UpdateEnrollmentStatusOutput with field(s):
  • status(Option<Status>):

    The enrollment status of the account.

  • status_reason(Option<String>):

    The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

• On failure, responds with SdkError<UpdateEnrollmentStatusError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf has retry or timeouts enabled without a sleep_impl. If you experience this panic, it can be fixed by setting the sleep_impl, or by disabling retries and timeouts.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.