Struct Client

pub struct Client { /* private fields */ }

Client for CloudWatch Observability Admin Service

Client for invoking operations on CloudWatch Observability Admin Service. Each operation on CloudWatch Observability Admin Service 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_observabilityadmin::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 Builder 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_observabilityadmin::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 ListResourceTelemetry operation has a Client::list_resource_telemetry, 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.list_resource_telemetry()
    .resource_identifier_prefix("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_telemetry_evaluation_status( &self, ) -> GetTelemetryEvaluationStatusFluentBuilder

Constructs a fluent builder for the GetTelemetryEvaluationStatus operation.

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

    The onboarding status of the telemetry config feature.

  • failure_reason(Option<String>):

    Describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.

• On failure, responds with SdkError<GetTelemetryEvaluationStatusError>

impl Client

pub fn get_telemetry_evaluation_status_for_organization( &self, ) -> GetTelemetryEvaluationStatusForOrganizationFluentBuilder

Constructs a fluent builder for the GetTelemetryEvaluationStatusForOrganization operation.

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

    The onboarding status of the telemetry config feature for the organization.

  • failure_reason(Option<String>):

    This field describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.

• On failure, responds with SdkError<GetTelemetryEvaluationStatusForOrganizationError>

impl Client

pub fn list_resource_telemetry(&self) -> ListResourceTelemetryFluentBuilder

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

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

    A string used to filter resources which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

    
    
  • resource_types(ResourceType) / set_resource_types(Option<Vec::<ResourceType>>):
    required: false
    

    A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used in the request.

    
    
  • telemetry_configuration_state(TelemetryType, TelemetryState) / set_telemetry_configuration_state(Option<HashMap::<TelemetryType, TelemetryState>>):
    required: false
    

    A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

    
    
  • resource_tags(impl Into<String>, impl Into<String>) / set_resource_tags(Option<HashMap::<String, String>>):
    required: false
    

    A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?

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

    A number field used to limit the number of results within the returned list.

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

    The token for the next set of items to return. A previous call generates this token.

    
    
• On success, responds with ListResourceTelemetryOutput with field(s):
  • telemetry_configurations(Option<Vec::<TelemetryConfiguration>>):

    A list of telemetry configurations for AWS resources supported by telemetry config in the caller’s account.

  • next_token(Option<String>):

    The token for the next set of items to return. A previous call generates this token.

• On failure, responds with SdkError<ListResourceTelemetryError>

impl Client

pub fn list_resource_telemetry_for_organization( &self, ) -> ListResourceTelemetryForOrganizationFluentBuilder

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

• The fluent builder is configurable:
  • account_identifiers(impl Into<String>) / set_account_identifiers(Option<Vec::<String>>):
    required: false
    

    A list of AWS account IDs used to filter the resources to those associated with the specified accounts.

    
    
  • resource_identifier_prefix(impl Into<String>) / set_resource_identifier_prefix(Option<String>):
    required: false
    

    A string used to filter resources in the organization which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

    
    
  • resource_types(ResourceType) / set_resource_types(Option<Vec::<ResourceType>>):
    required: false
    

    A list of resource types used to filter resources in the organization. If this parameter is provided, the resources will be returned in the same order used in the request.

    
    
  • telemetry_configuration_state(TelemetryType, TelemetryState) / set_telemetry_configuration_state(Option<HashMap::<TelemetryType, TelemetryState>>):
    required: false
    

    A key-value pair to filter resources in the organization based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

    
    
  • resource_tags(impl Into<String>, impl Into<String>) / set_resource_tags(Option<HashMap::<String, String>>):
    required: false
    

    A key-value pair to filter resources in the organization based on tags associated with the resource. Fore more information about tags, see What are tags?

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

    A number field used to limit the number of results within the returned list.

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

    The token for the next set of items to return. A previous call provides this token.

    
    
• On success, responds with ListResourceTelemetryForOrganizationOutput with field(s):
  • telemetry_configurations(Option<Vec::<TelemetryConfiguration>>):

    A list of telemetry configurations for AWS resources supported by telemetry config in the organization.

  • next_token(Option<String>):

    The token for the next set of items to return. A previous call provides this token.

• On failure, responds with SdkError<ListResourceTelemetryForOrganizationError>

impl Client

pub fn start_telemetry_evaluation( &self, ) -> StartTelemetryEvaluationFluentBuilder

Constructs a fluent builder for the StartTelemetryEvaluation operation.

• The fluent builder takes no input, just send it.
• On success, responds with StartTelemetryEvaluationOutput
• On failure, responds with SdkError<StartTelemetryEvaluationError>

impl Client

pub fn start_telemetry_evaluation_for_organization( &self, ) -> StartTelemetryEvaluationForOrganizationFluentBuilder

Constructs a fluent builder for the StartTelemetryEvaluationForOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with StartTelemetryEvaluationForOrganizationOutput
• On failure, responds with SdkError<StartTelemetryEvaluationForOrganizationError>

impl Client

pub fn stop_telemetry_evaluation(&self) -> StopTelemetryEvaluationFluentBuilder

Constructs a fluent builder for the StopTelemetryEvaluation operation.

• The fluent builder takes no input, just send it.
• On success, responds with StopTelemetryEvaluationOutput
• On failure, responds with SdkError<StopTelemetryEvaluationError>

impl Client

pub fn stop_telemetry_evaluation_for_organization( &self, ) -> StopTelemetryEvaluationForOrganizationFluentBuilder

Constructs a fluent builder for the StopTelemetryEvaluationForOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with StopTelemetryEvaluationForOrganizationOutput
• On failure, responds with SdkError<StopTelemetryEvaluationForOrganizationError>

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 duplicate 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.