Struct aws_sdk_trustedadvisor::client::Client

pub struct Client { /* private fields */ }

Client for TrustedAdvisor Public API

Client for invoking operations on TrustedAdvisor Public API. Each operation on TrustedAdvisor Public API 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_trustedadvisor::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_trustedadvisor::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 GetOrganizationRecommendation operation has a Client::get_organization_recommendation, 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.get_organization_recommendation()
    .organization_recommendation_identifier("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 get_organization_recommendation( &self ) -> GetOrganizationRecommendationFluentBuilder

Constructs a fluent builder for the GetOrganizationRecommendation operation.

• The fluent builder is configurable:
  • organization_recommendation_identifier(impl Into<String>) / set_organization_recommendation_identifier(Option<String>):
    required: true
    

    The Recommendation identifier

    
    
• On success, responds with GetOrganizationRecommendationOutput with field(s):
  • organization_recommendation(Option<OrganizationRecommendation>):

    The Recommendation

• On failure, responds with SdkError<GetOrganizationRecommendationError>

impl Client

pub fn get_recommendation(&self) -> GetRecommendationFluentBuilder

Constructs a fluent builder for the GetRecommendation operation.

• The fluent builder is configurable:
  • recommendation_identifier(impl Into<String>) / set_recommendation_identifier(Option<String>):
    required: true
    

    The Recommendation identifier

    
    
• On success, responds with GetRecommendationOutput with field(s):
  • recommendation(Option<Recommendation>):

    The Recommendation

• On failure, responds with SdkError<GetRecommendationError>

impl Client

pub fn list_checks(&self) -> ListChecksFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • pillar(RecommendationPillar) / set_pillar(Option<RecommendationPillar>):
    required: false
    

    The pillar of the check

    
    
  • aws_service(impl Into<String>) / set_aws_service(Option<String>):
    required: false
    

    The aws service associated with the check

    
    
  • source(RecommendationSource) / set_source(Option<RecommendationSource>):
    required: false
    

    The source of the check

    
    
  • language(RecommendationLanguage) / set_language(Option<RecommendationLanguage>):
    required: false
    

    The ISO 639-1 code for the language that you want your checks to appear in.

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • check_summaries(Vec::<CheckSummary>):

    The list of Checks

• On failure, responds with SdkError<ListChecksError>

impl Client

pub fn list_organization_recommendation_accounts( &self ) -> ListOrganizationRecommendationAccountsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • organization_recommendation_identifier(impl Into<String>) / set_organization_recommendation_identifier(Option<String>):
    required: true
    

    The Recommendation identifier

    
    
  • affected_account_id(impl Into<String>) / set_affected_account_id(Option<String>):
    required: false
    

    An account affected by this organization recommendation

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • account_recommendation_lifecycle_summaries(Vec::<AccountRecommendationLifecycleSummary>):

    The account recommendations lifecycles that are applicable to the Recommendation

• On failure, responds with SdkError<ListOrganizationRecommendationAccountsError>

impl Client

pub fn list_organization_recommendation_resources( &self ) -> ListOrganizationRecommendationResourcesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • status(ResourceStatus) / set_status(Option<ResourceStatus>):
    required: false
    

    The status of the resource

    
    
  • region_code(impl Into<String>) / set_region_code(Option<String>):
    required: false
    

    The AWS Region code of the resource

    
    
  • organization_recommendation_identifier(impl Into<String>) / set_organization_recommendation_identifier(Option<String>):
    required: true
    

    The AWS Organization organization’s Recommendation identifier

    
    
  • affected_account_id(impl Into<String>) / set_affected_account_id(Option<String>):
    required: false
    

    An account affected by this organization recommendation

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • organization_recommendation_resource_summaries(Vec::<OrganizationRecommendationResourceSummary>):

    A list of Recommendation Resources

• On failure, responds with SdkError<ListOrganizationRecommendationResourcesError>

impl Client

pub fn list_organization_recommendations( &self ) -> ListOrganizationRecommendationsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • r#type(RecommendationType) / set_type(Option<RecommendationType>):
    required: false
    

    The type of the Recommendation

    
    
  • status(RecommendationStatus) / set_status(Option<RecommendationStatus>):
    required: false
    

    The status of the Recommendation

    
    
  • pillar(RecommendationPillar) / set_pillar(Option<RecommendationPillar>):
    required: false
    

    The pillar of the Recommendation

    
    
  • aws_service(impl Into<String>) / set_aws_service(Option<String>):
    required: false
    

    The aws service associated with the Recommendation

    
    
  • source(RecommendationSource) / set_source(Option<RecommendationSource>):
    required: false
    

    The source of the Recommendation

    
    
  • check_identifier(impl Into<String>) / set_check_identifier(Option<String>):
    required: false
    

    The check identifier of the Recommendation

    
    
  • after_last_updated_at(DateTime) / set_after_last_updated_at(Option<DateTime>):
    required: false
    

    After the last update of the Recommendation

    
    
  • before_last_updated_at(DateTime) / set_before_last_updated_at(Option<DateTime>):
    required: false
    

    Before the last update of the Recommendation

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • organization_recommendation_summaries(Vec::<OrganizationRecommendationSummary>):

    The list of Recommendations

• On failure, responds with SdkError<ListOrganizationRecommendationsError>

impl Client

pub fn list_recommendation_resources( &self ) -> ListRecommendationResourcesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • status(ResourceStatus) / set_status(Option<ResourceStatus>):
    required: false
    

    The status of the resource

    
    
  • region_code(impl Into<String>) / set_region_code(Option<String>):
    required: false
    

    The AWS Region code of the resource

    
    
  • recommendation_identifier(impl Into<String>) / set_recommendation_identifier(Option<String>):
    required: true
    

    The Recommendation identifier

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • recommendation_resource_summaries(Vec::<RecommendationResourceSummary>):

    A list of Recommendation Resources

• On failure, responds with SdkError<ListRecommendationResourcesError>

impl Client

pub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

    
    
  • r#type(RecommendationType) / set_type(Option<RecommendationType>):
    required: false
    

    The type of the Recommendation

    
    
  • status(RecommendationStatus) / set_status(Option<RecommendationStatus>):
    required: false
    

    The status of the Recommendation

    
    
  • pillar(RecommendationPillar) / set_pillar(Option<RecommendationPillar>):
    required: false
    

    The pillar of the Recommendation

    
    
  • aws_service(impl Into<String>) / set_aws_service(Option<String>):
    required: false
    

    The aws service associated with the Recommendation

    
    
  • source(RecommendationSource) / set_source(Option<RecommendationSource>):
    required: false
    

    The source of the Recommendation

    
    
  • check_identifier(impl Into<String>) / set_check_identifier(Option<String>):
    required: false
    

    The check identifier of the Recommendation

    
    
  • after_last_updated_at(DateTime) / set_after_last_updated_at(Option<DateTime>):
    required: false
    

    After the last update of the Recommendation

    
    
  • before_last_updated_at(DateTime) / set_before_last_updated_at(Option<DateTime>):
    required: false
    

    Before the last update of the Recommendation

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • recommendation_summaries(Vec::<RecommendationSummary>):

    The list of Recommendations

• On failure, responds with SdkError<ListRecommendationsError>

impl Client

pub fn update_organization_recommendation_lifecycle( &self ) -> UpdateOrganizationRecommendationLifecycleFluentBuilder

Constructs a fluent builder for the UpdateOrganizationRecommendationLifecycle operation.

• The fluent builder is configurable:
  • lifecycle_stage(UpdateRecommendationLifecycleStage) / set_lifecycle_stage(Option<UpdateRecommendationLifecycleStage>):
    required: true
    

    The new lifecycle stage

    
    
  • update_reason(impl Into<String>) / set_update_reason(Option<String>):
    required: false
    

    Reason for the lifecycle stage change

    
    
  • update_reason_code(UpdateRecommendationLifecycleStageReasonCode) / set_update_reason_code(Option<UpdateRecommendationLifecycleStageReasonCode>):
    required: false
    

    Reason code for the lifecycle state change

    
    
  • organization_recommendation_identifier(impl Into<String>) / set_organization_recommendation_identifier(Option<String>):
    required: true
    

    The Recommendation identifier for AWS Trusted Advisor Priority recommendations

    
    
• On success, responds with UpdateOrganizationRecommendationLifecycleOutput
• On failure, responds with SdkError<UpdateOrganizationRecommendationLifecycleError>

impl Client

pub fn update_recommendation_lifecycle( &self ) -> UpdateRecommendationLifecycleFluentBuilder

Constructs a fluent builder for the UpdateRecommendationLifecycle operation.

• The fluent builder is configurable:
  • lifecycle_stage(UpdateRecommendationLifecycleStage) / set_lifecycle_stage(Option<UpdateRecommendationLifecycleStage>):
    required: true
    

    The new lifecycle stage

    
    
  • update_reason(impl Into<String>) / set_update_reason(Option<String>):
    required: false
    

    Reason for the lifecycle stage change

    
    
  • update_reason_code(UpdateRecommendationLifecycleStageReasonCode) / set_update_reason_code(Option<UpdateRecommendationLifecycleStageReasonCode>):
    required: false
    

    Reason code for the lifecycle state change

    
    
  • recommendation_identifier(impl Into<String>) / set_recommendation_identifier(Option<String>):
    required: true
    

    The Recommendation identifier for AWS Trusted Advisor Priority recommendations

    
    
• On success, responds with UpdateRecommendationLifecycleOutput
• On failure, responds with SdkError<UpdateRecommendationLifecycleError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

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.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

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.