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 CreateTelemetryRule operation has a Client::create_telemetry_rule, 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.create_telemetry_rule()
    .rule_name("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 create_telemetry_rule(&self) -> CreateTelemetryRuleFluentBuilder

Constructs a fluent builder for the CreateTelemetryRule operation.

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

    A unique name for the telemetry rule being created.

    
    
  • rule(TelemetryRule) / set_rule(Option<TelemetryRule>):
    required: true
    

    The configuration details for the telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The key-value pairs to associate with the telemetry rule resource for categorization and management purposes.

    
    
• On success, responds with CreateTelemetryRuleOutput with field(s):
  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the created telemetry rule.

• On failure, responds with SdkError<CreateTelemetryRuleError>

impl Client

pub fn create_telemetry_rule_for_organization( &self, ) -> CreateTelemetryRuleForOrganizationFluentBuilder

Constructs a fluent builder for the CreateTelemetryRuleForOrganization operation.

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

    A unique name for the organization-wide telemetry rule being created.

    
    
  • rule(TelemetryRule) / set_rule(Option<TelemetryRule>):
    required: true
    

    The configuration details for the organization-wide telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to across the organization.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.

    
    
• On success, responds with CreateTelemetryRuleForOrganizationOutput with field(s):
  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the created organization telemetry rule.

• On failure, responds with SdkError<CreateTelemetryRuleForOrganizationError>

impl Client

pub fn delete_telemetry_rule(&self) -> DeleteTelemetryRuleFluentBuilder

Constructs a fluent builder for the DeleteTelemetryRule operation.

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

    The identifier (name or ARN) of the telemetry rule to delete.

    
    
• On success, responds with DeleteTelemetryRuleOutput
• On failure, responds with SdkError<DeleteTelemetryRuleError>

impl Client

pub fn delete_telemetry_rule_for_organization( &self, ) -> DeleteTelemetryRuleForOrganizationFluentBuilder

Constructs a fluent builder for the DeleteTelemetryRuleForOrganization operation.

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

    The identifier (name or ARN) of the organization telemetry rule to delete.

    
    
• On success, responds with DeleteTelemetryRuleForOrganizationOutput
• On failure, responds with SdkError<DeleteTelemetryRuleForOrganizationError>

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 get_telemetry_rule(&self) -> GetTelemetryRuleFluentBuilder

Constructs a fluent builder for the GetTelemetryRule operation.

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

    The identifier (name or ARN) of the telemetry rule to retrieve.

    
    
• On success, responds with GetTelemetryRuleOutput with field(s):
  • rule_name(Option<String>):

    The name of the telemetry rule.

  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the telemetry rule.

  • created_time_stamp(Option<i64>):

    The timestamp when the telemetry rule was created.

  • last_update_time_stamp(Option<i64>):

    The timestamp when the telemetry rule was last updated.

  • telemetry_rule(Option<TelemetryRule>):

    The configuration details of the telemetry rule.

• On failure, responds with SdkError<GetTelemetryRuleError>

impl Client

pub fn get_telemetry_rule_for_organization( &self, ) -> GetTelemetryRuleForOrganizationFluentBuilder

Constructs a fluent builder for the GetTelemetryRuleForOrganization operation.

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

    The identifier (name or ARN) of the organization telemetry rule to retrieve.

    
    
• On success, responds with GetTelemetryRuleForOrganizationOutput with field(s):
  • rule_name(Option<String>):

    The name of the organization telemetry rule.

  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the organization telemetry rule.

  • created_time_stamp(Option<i64>):

    The timestamp when the organization telemetry rule was created.

  • last_update_time_stamp(Option<i64>):

    The timestamp when the organization telemetry rule was last updated.

  • telemetry_rule(Option<TelemetryRule>):

    The configuration details of the organization telemetry rule.

• On failure, responds with SdkError<GetTelemetryRuleForOrganizationError>

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 Amazon Web Services 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 Amazon Web Services accounts 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 Amazon Web Services 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 list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) of the telemetry rule resource whose tags you want to list.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(HashMap::<String, String>):

    The list of tags associated with the telemetry rule resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_telemetry_rules(&self) -> ListTelemetryRulesFluentBuilder

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

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

    A string to filter telemetry rules whose names begin with the specified prefix.

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

    The maximum number of telemetry rules to return in a single call.

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

    The token for the next set of results. A previous call generates this token.

    
    
• On success, responds with ListTelemetryRulesOutput with field(s):
  • telemetry_rule_summaries(Option<Vec::<TelemetryRuleSummary>>):

    A list of telemetry rule summaries.

  • next_token(Option<String>):

    A token to resume pagination of results.

• On failure, responds with SdkError<ListTelemetryRulesError>

impl Client

pub fn list_telemetry_rules_for_organization( &self, ) -> ListTelemetryRulesForOrganizationFluentBuilder

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

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

    A string to filter organization telemetry rules whose names begin with the specified prefix.

    
    
  • source_account_ids(impl Into<String>) / set_source_account_ids(Option<Vec::<String>>):
    required: false
    

    The list of account IDs to filter organization telemetry rules by their source accounts.

    
    
  • source_organization_unit_ids(impl Into<String>) / set_source_organization_unit_ids(Option<Vec::<String>>):
    required: false
    

    The list of organizational unit IDs to filter organization telemetry rules by their source organizational units.

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

    The maximum number of organization telemetry rules to return in a single call.

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

    The token for the next set of results. A previous call generates this token.

    
    
• On success, responds with ListTelemetryRulesForOrganizationOutput with field(s):
  • telemetry_rule_summaries(Option<Vec::<TelemetryRuleSummary>>):

    A list of organization telemetry rule summaries.

  • next_token(Option<String>):

    A token to resume pagination of results.

• On failure, responds with SdkError<ListTelemetryRulesForOrganizationError>

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 tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the telemetry rule resource to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The key-value pairs to add or update for the telemetry rule resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the telemetry rule resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the telemetry rule resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_telemetry_rule(&self) -> UpdateTelemetryRuleFluentBuilder

Constructs a fluent builder for the UpdateTelemetryRule operation.

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

    The identifier (name or ARN) of the telemetry rule to update.

    
    
  • rule(TelemetryRule) / set_rule(Option<TelemetryRule>):
    required: true
    

    The new configuration details for the telemetry rule.

    
    
• On success, responds with UpdateTelemetryRuleOutput with field(s):
  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the updated telemetry rule.

• On failure, responds with SdkError<UpdateTelemetryRuleError>

impl Client

pub fn update_telemetry_rule_for_organization( &self, ) -> UpdateTelemetryRuleForOrganizationFluentBuilder

Constructs a fluent builder for the UpdateTelemetryRuleForOrganization operation.

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

    The identifier (name or ARN) of the organization telemetry rule to update.

    
    
  • rule(TelemetryRule) / set_rule(Option<TelemetryRule>):
    required: true
    

    The new configuration details for the organization telemetry rule, including resource type, telemetry type, and destination configuration.

    
    
• On success, responds with UpdateTelemetryRuleForOrganizationOutput with field(s):
  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the updated organization telemetry rule.

• On failure, responds with SdkError<UpdateTelemetryRuleForOrganizationError>

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.