Struct aws_sdk_devopsguru::Client

source ·
pub struct Client { /* private fields */ }
Expand description

Client for Amazon DevOps Guru

Client for invoking operations on Amazon DevOps Guru. Each operation on Amazon DevOps Guru 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_devopsguru::Client::new(&config);

Occasionally, SDKs may have additional service-specific values 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_devopsguru::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 DeleteInsight operation has a Client::delete_insight, 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_insight()
    .id("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§

source§

impl Client

source

pub fn add_notification_channel(&self) -> AddNotificationChannelFluentBuilder

Constructs a fluent builder for the AddNotificationChannel operation.

source§

impl Client

source

pub fn delete_insight(&self) -> DeleteInsightFluentBuilder

Constructs a fluent builder for the DeleteInsight operation.

source§

impl Client

source

pub fn describe_account_health(&self) -> DescribeAccountHealthFluentBuilder

Constructs a fluent builder for the DescribeAccountHealth operation.

source§

impl Client

source

pub fn describe_account_overview(&self) -> DescribeAccountOverviewFluentBuilder

Constructs a fluent builder for the DescribeAccountOverview operation.

source§

impl Client

source

pub fn describe_anomaly(&self) -> DescribeAnomalyFluentBuilder

Constructs a fluent builder for the DescribeAnomaly operation.

source§

impl Client

source

pub fn describe_event_sources_config( &self ) -> DescribeEventSourcesConfigFluentBuilder

Constructs a fluent builder for the DescribeEventSourcesConfig operation.

source§

impl Client

source

pub fn describe_feedback(&self) -> DescribeFeedbackFluentBuilder

Constructs a fluent builder for the DescribeFeedback operation.

source§

impl Client

source

pub fn describe_insight(&self) -> DescribeInsightFluentBuilder

Constructs a fluent builder for the DescribeInsight operation.

source§

impl Client

source

pub fn describe_organization_health( &self ) -> DescribeOrganizationHealthFluentBuilder

Constructs a fluent builder for the DescribeOrganizationHealth operation.

source§

impl Client

source

pub fn describe_organization_overview( &self ) -> DescribeOrganizationOverviewFluentBuilder

Constructs a fluent builder for the DescribeOrganizationOverview operation.

source§

impl Client

source

pub fn describe_organization_resource_collection_health( &self ) -> DescribeOrganizationResourceCollectionHealthFluentBuilder

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

  • The fluent builder is configurable:
  • On success, responds with DescribeOrganizationResourceCollectionHealthOutput with field(s):
    • cloud_formation(Option<Vec::<CloudFormationHealth>>):

      The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

    • service(Option<Vec::<ServiceHealth>>):

      An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.

    • account(Option<Vec::<AccountHealth>>):

      The name of the organization’s account.

    • next_token(Option<String>):

      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

    • tags(Option<Vec::<TagHealth>>):

      Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

      Each Amazon Web Services tag has two parts.

      • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

      • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

      Together these are known as key-value pairs.

      The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

  • On failure, responds with SdkError<DescribeOrganizationResourceCollectionHealthError>
source§

impl Client

source

pub fn describe_resource_collection_health( &self ) -> DescribeResourceCollectionHealthFluentBuilder

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

  • The fluent builder is configurable:
    • resource_collection_type(ResourceCollectionType) / set_resource_collection_type(Option<ResourceCollectionType>):
      required: true

      An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.


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

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.


  • On success, responds with DescribeResourceCollectionHealthOutput with field(s):
    • cloud_formation(Option<Vec::<CloudFormationHealth>>):

      The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

    • service(Option<Vec::<ServiceHealth>>):

      An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.

    • next_token(Option<String>):

      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

    • tags(Option<Vec::<TagHealth>>):

      The Amazon Web Services tags that are used by resources in the resource collection.

      Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

      Each Amazon Web Services tag has two parts.

      • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

      • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

      Together these are known as key-value pairs.

      The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

  • On failure, responds with SdkError<DescribeResourceCollectionHealthError>
source§

impl Client

source

pub fn describe_service_integration( &self ) -> DescribeServiceIntegrationFluentBuilder

Constructs a fluent builder for the DescribeServiceIntegration operation.

source§

impl Client

source

pub fn get_cost_estimation(&self) -> GetCostEstimationFluentBuilder

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

source§

impl Client

source

pub fn get_resource_collection(&self) -> GetResourceCollectionFluentBuilder

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

source§

impl Client

source

pub fn list_anomalies_for_insight(&self) -> ListAnomaliesForInsightFluentBuilder

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

source§

impl Client

source

pub fn list_anomalous_log_groups(&self) -> ListAnomalousLogGroupsFluentBuilder

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

source§

impl Client

source

pub fn list_events(&self) -> ListEventsFluentBuilder

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

source§

impl Client

source

pub fn list_insights(&self) -> ListInsightsFluentBuilder

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

source§

impl Client

source

pub fn list_monitored_resources(&self) -> ListMonitoredResourcesFluentBuilder

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

source§

impl Client

source

pub fn list_notification_channels( &self ) -> ListNotificationChannelsFluentBuilder

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

source§

impl Client

source

pub fn list_organization_insights( &self ) -> ListOrganizationInsightsFluentBuilder

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

source§

impl Client

source

pub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder

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

source§

impl Client

source

pub fn put_feedback(&self) -> PutFeedbackFluentBuilder

Constructs a fluent builder for the PutFeedback operation.

source§

impl Client

source

pub fn remove_notification_channel( &self ) -> RemoveNotificationChannelFluentBuilder

Constructs a fluent builder for the RemoveNotificationChannel operation.

source§

impl Client

source

pub fn search_insights(&self) -> SearchInsightsFluentBuilder

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

source§

impl Client

source

pub fn search_organization_insights( &self ) -> SearchOrganizationInsightsFluentBuilder

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

source§

impl Client

source

pub fn start_cost_estimation(&self) -> StartCostEstimationFluentBuilder

Constructs a fluent builder for the StartCostEstimation operation.

source§

impl Client

source

pub fn update_event_sources_config( &self ) -> UpdateEventSourcesConfigFluentBuilder

Constructs a fluent builder for the UpdateEventSourcesConfig operation.

source§

impl Client

source

pub fn update_resource_collection( &self ) -> UpdateResourceCollectionFluentBuilder

Constructs a fluent builder for the UpdateResourceCollection operation.

source§

impl Client

source

pub fn update_service_integration( &self ) -> UpdateServiceIntegrationFluentBuilder

Constructs a fluent builder for the UpdateServiceIntegration operation.

source§

impl Client

source

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.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more