pub struct Client { /* private fields */ }Expand description
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 CreateCentralizationRuleForOrganization operation has
a Client::create_centralization_rule_for_organization, 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_centralization_rule_for_organization()
.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§
Source§impl Client
impl Client
Sourcepub fn create_centralization_rule_for_organization(
&self,
) -> CreateCentralizationRuleForOrganizationFluentBuilder
pub fn create_centralization_rule_for_organization( &self, ) -> CreateCentralizationRuleForOrganizationFluentBuilder
Constructs a fluent builder for the CreateCentralizationRuleForOrganization operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)/set_rule_name(Option<String>):
required: trueA unique name for the organization-wide centralization rule being created.
rule(CentralizationRule)/set_rule(Option<CentralizationRule>):
required: trueThe configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
- On success, responds with
CreateCentralizationRuleForOrganizationOutputwith field(s):rule_arn(Option<String>):The Amazon Resource Name (ARN) of the created organization centralization rule.
- On failure, responds with
SdkError<CreateCentralizationRuleForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn create_telemetry_rule(&self) -> CreateTelemetryRuleFluentBuilder
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: trueA unique name for the telemetry rule being created.
rule(TelemetryRule)/set_rule(Option<TelemetryRule>):
required: trueThe 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: falseThe key-value pairs to associate with the telemetry rule resource for categorization and management purposes.
- On success, responds with
CreateTelemetryRuleOutputwith field(s):rule_arn(Option<String>):The Amazon Resource Name (ARN) of the created telemetry rule.
- On failure, responds with
SdkError<CreateTelemetryRuleError>
Source§impl Client
impl Client
Sourcepub fn create_telemetry_rule_for_organization(
&self,
) -> CreateTelemetryRuleForOrganizationFluentBuilder
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: trueA unique name for the organization-wide telemetry rule being created.
rule(TelemetryRule)/set_rule(Option<TelemetryRule>):
required: trueThe 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: falseThe key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
- On success, responds with
CreateTelemetryRuleForOrganizationOutputwith field(s):rule_arn(Option<String>):The Amazon Resource Name (ARN) of the created organization telemetry rule.
- On failure, responds with
SdkError<CreateTelemetryRuleForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn delete_centralization_rule_for_organization(
&self,
) -> DeleteCentralizationRuleForOrganizationFluentBuilder
pub fn delete_centralization_rule_for_organization( &self, ) -> DeleteCentralizationRuleForOrganizationFluentBuilder
Constructs a fluent builder for the DeleteCentralizationRuleForOrganization operation.
- The fluent builder is configurable:
rule_identifier(impl Into<String>)/set_rule_identifier(Option<String>):
required: trueThe identifier (name or ARN) of the organization centralization rule to delete.
- On success, responds with
DeleteCentralizationRuleForOrganizationOutput - On failure, responds with
SdkError<DeleteCentralizationRuleForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn delete_telemetry_rule(&self) -> DeleteTelemetryRuleFluentBuilder
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: trueThe identifier (name or ARN) of the telemetry rule to delete.
- On success, responds with
DeleteTelemetryRuleOutput - On failure, responds with
SdkError<DeleteTelemetryRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_telemetry_rule_for_organization(
&self,
) -> DeleteTelemetryRuleForOrganizationFluentBuilder
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: trueThe identifier (name or ARN) of the organization telemetry rule to delete.
- On success, responds with
DeleteTelemetryRuleForOrganizationOutput - On failure, responds with
SdkError<DeleteTelemetryRuleForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn get_centralization_rule_for_organization(
&self,
) -> GetCentralizationRuleForOrganizationFluentBuilder
pub fn get_centralization_rule_for_organization( &self, ) -> GetCentralizationRuleForOrganizationFluentBuilder
Constructs a fluent builder for the GetCentralizationRuleForOrganization operation.
- The fluent builder is configurable:
rule_identifier(impl Into<String>)/set_rule_identifier(Option<String>):
required: trueThe identifier (name or ARN) of the organization centralization rule to retrieve.
- On success, responds with
GetCentralizationRuleForOrganizationOutputwith field(s):rule_name(Option<String>):The name of the organization centralization rule.
rule_arn(Option<String>):The Amazon Resource Name (ARN) of the organization centralization rule.
creator_account_id(Option<String>):The Amazon Web Services Account that created the organization centralization rule.
created_time_stamp(Option<i64>):The timestamp when the organization centralization rule was created.
created_region(Option<String>):The Amazon Web Services region where the organization centralization rule was created.
last_update_time_stamp(Option<i64>):The timestamp when the organization centralization rule was last updated.
rule_health(Option<RuleHealth>):The health status of the organization centralization rule.
failure_reason(Option<CentralizationFailureReason>):The reason why an organization centralization rule is marked UNHEALTHY.
centralization_rule(Option<CentralizationRule>):The configuration details for the organization centralization rule.
- On failure, responds with
SdkError<GetCentralizationRuleForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn get_telemetry_enrichment_status(
&self,
) -> GetTelemetryEnrichmentStatusFluentBuilder
pub fn get_telemetry_enrichment_status( &self, ) -> GetTelemetryEnrichmentStatusFluentBuilder
Constructs a fluent builder for the GetTelemetryEnrichmentStatus operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetTelemetryEnrichmentStatusOutputwith field(s):status(Option<TelemetryEnrichmentStatus>):The current status of the resource tags for telemetry feature (
Running,Stopped, orImpaired).aws_resource_explorer_managed_view_arn(Option<String>):The Amazon Resource Name (ARN) of the Amazon Web Services Resource Explorer managed view used for resource tags for telemetry, if the feature is enabled.
- On failure, responds with
SdkError<GetTelemetryEnrichmentStatusError>
Source§impl Client
impl Client
Sourcepub fn get_telemetry_evaluation_status(
&self,
) -> GetTelemetryEvaluationStatusFluentBuilder
pub fn get_telemetry_evaluation_status( &self, ) -> GetTelemetryEvaluationStatusFluentBuilder
Constructs a fluent builder for the GetTelemetryEvaluationStatus operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetTelemetryEvaluationStatusOutputwith 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
StatusisFAILED_STARTorFAILED_STOP.
- On failure, responds with
SdkError<GetTelemetryEvaluationStatusError>
Source§impl Client
impl Client
Sourcepub fn get_telemetry_evaluation_status_for_organization(
&self,
) -> GetTelemetryEvaluationStatusForOrganizationFluentBuilder
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
sendit. - On success, responds with
GetTelemetryEvaluationStatusForOrganizationOutputwith 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
StatusisFAILED_STARTorFAILED_STOP.
- On failure, responds with
SdkError<GetTelemetryEvaluationStatusForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn get_telemetry_rule(&self) -> GetTelemetryRuleFluentBuilder
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: trueThe identifier (name or ARN) of the telemetry rule to retrieve.
- On success, responds with
GetTelemetryRuleOutputwith 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>
Source§impl Client
impl Client
Sourcepub fn get_telemetry_rule_for_organization(
&self,
) -> GetTelemetryRuleForOrganizationFluentBuilder
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: trueThe identifier (name or ARN) of the organization telemetry rule to retrieve.
- On success, responds with
GetTelemetryRuleForOrganizationOutputwith 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>
Source§impl Client
impl Client
Sourcepub fn list_centralization_rules_for_organization(
&self,
) -> ListCentralizationRulesForOrganizationFluentBuilder
pub fn list_centralization_rules_for_organization( &self, ) -> ListCentralizationRulesForOrganizationFluentBuilder
Constructs a fluent builder for the ListCentralizationRulesForOrganization 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: falseA string to filter organization centralization rules whose names begin with the specified prefix.
all_regions(bool)/set_all_regions(Option<bool>):
required: falseA flag determining whether to return organization centralization rules from all regions or only the current region.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of organization centralization rules to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. A previous call generates this token.
- On success, responds with
ListCentralizationRulesForOrganizationOutputwith field(s):centralization_rule_summaries(Option<Vec::<CentralizationRuleSummary>>):A list of centralization rule summaries.
next_token(Option<String>):A token to resume pagination of results.
- On failure, responds with
SdkError<ListCentralizationRulesForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn list_resource_telemetry(&self) -> ListResourceTelemetryFluentBuilder
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: falseA string used to filter resources which have a
ResourceIdentifierstarting with theResourceIdentifierPrefix.resource_types(ResourceType)/set_resource_types(Option<Vec::<ResourceType>>):
required: falseA 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: falseA 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: falseA 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: falseA number field used to limit the number of results within the returned list.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of items to return. A previous call generates this token.
- On success, responds with
ListResourceTelemetryOutputwith 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>
Source§impl Client
impl Client
Sourcepub fn list_resource_telemetry_for_organization(
&self,
) -> ListResourceTelemetryForOrganizationFluentBuilder
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: falseA 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: falseA string used to filter resources in the organization which have a
ResourceIdentifierstarting with theResourceIdentifierPrefix.resource_types(ResourceType)/set_resource_types(Option<Vec::<ResourceType>>):
required: falseA 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: falseA 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: falseA 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: falseA number field used to limit the number of results within the returned list.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of items to return. A previous call provides this token.
- On success, responds with
ListResourceTelemetryForOrganizationOutputwith 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>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the telemetry rule resource whose tags you want to list.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(HashMap::<String, String>):The list of tags associated with the telemetry rule resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_telemetry_rules(&self) -> ListTelemetryRulesFluentBuilder
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: falseA string to filter telemetry rules whose names begin with the specified prefix.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of telemetry rules to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. A previous call generates this token.
- On success, responds with
ListTelemetryRulesOutputwith 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>
Source§impl Client
impl Client
Sourcepub fn list_telemetry_rules_for_organization(
&self,
) -> ListTelemetryRulesForOrganizationFluentBuilder
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: falseA 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: falseThe 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: falseThe list of organizational unit IDs to filter organization telemetry rules by their source organizational units.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of organization telemetry rules to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. A previous call generates this token.
- On success, responds with
ListTelemetryRulesForOrganizationOutputwith 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>
Source§impl Client
impl Client
Sourcepub fn start_telemetry_enrichment(
&self,
) -> StartTelemetryEnrichmentFluentBuilder
pub fn start_telemetry_enrichment( &self, ) -> StartTelemetryEnrichmentFluentBuilder
Constructs a fluent builder for the StartTelemetryEnrichment operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
StartTelemetryEnrichmentOutputwith field(s):status(Option<TelemetryEnrichmentStatus>):The status of the resource tags for telemetry feature after the start operation (
Running,Stopped, orImpaired).aws_resource_explorer_managed_view_arn(Option<String>):The Amazon Resource Name (ARN) of the Amazon Web Services Resource Explorer managed view created for resource tags for telemetry.
- On failure, responds with
SdkError<StartTelemetryEnrichmentError>
Source§impl Client
impl Client
Sourcepub fn start_telemetry_evaluation(
&self,
) -> StartTelemetryEvaluationFluentBuilder
pub fn start_telemetry_evaluation( &self, ) -> StartTelemetryEvaluationFluentBuilder
Constructs a fluent builder for the StartTelemetryEvaluation operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
StartTelemetryEvaluationOutput - On failure, responds with
SdkError<StartTelemetryEvaluationError>
Source§impl Client
impl Client
Sourcepub fn start_telemetry_evaluation_for_organization(
&self,
) -> StartTelemetryEvaluationForOrganizationFluentBuilder
pub fn start_telemetry_evaluation_for_organization( &self, ) -> StartTelemetryEvaluationForOrganizationFluentBuilder
Constructs a fluent builder for the StartTelemetryEvaluationForOrganization operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
StartTelemetryEvaluationForOrganizationOutput - On failure, responds with
SdkError<StartTelemetryEvaluationForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn stop_telemetry_enrichment(&self) -> StopTelemetryEnrichmentFluentBuilder
pub fn stop_telemetry_enrichment(&self) -> StopTelemetryEnrichmentFluentBuilder
Constructs a fluent builder for the StopTelemetryEnrichment operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
StopTelemetryEnrichmentOutputwith field(s):status(Option<TelemetryEnrichmentStatus>):The status of the resource tags for telemetry feature after the stop operation (
Running,Stopped, orImpaired).
- On failure, responds with
SdkError<StopTelemetryEnrichmentError>
Source§impl Client
impl Client
Sourcepub fn stop_telemetry_evaluation(&self) -> StopTelemetryEvaluationFluentBuilder
pub fn stop_telemetry_evaluation(&self) -> StopTelemetryEvaluationFluentBuilder
Constructs a fluent builder for the StopTelemetryEvaluation operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
StopTelemetryEvaluationOutput - On failure, responds with
SdkError<StopTelemetryEvaluationError>
Source§impl Client
impl Client
Sourcepub fn stop_telemetry_evaluation_for_organization(
&self,
) -> StopTelemetryEvaluationForOrganizationFluentBuilder
pub fn stop_telemetry_evaluation_for_organization( &self, ) -> StopTelemetryEvaluationForOrganizationFluentBuilder
Constructs a fluent builder for the StopTelemetryEvaluationForOrganization operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
StopTelemetryEvaluationForOrganizationOutput - On failure, responds with
SdkError<StopTelemetryEvaluationForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
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: trueThe 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: trueThe key-value pairs to add or update for the telemetry rule resource.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
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: trueThe 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: trueThe list of tag keys to remove from the telemetry rule resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_centralization_rule_for_organization(
&self,
) -> UpdateCentralizationRuleForOrganizationFluentBuilder
pub fn update_centralization_rule_for_organization( &self, ) -> UpdateCentralizationRuleForOrganizationFluentBuilder
Constructs a fluent builder for the UpdateCentralizationRuleForOrganization operation.
- The fluent builder is configurable:
rule_identifier(impl Into<String>)/set_rule_identifier(Option<String>):
required: trueThe identifier (name or ARN) of the organization centralization rule to update.
rule(CentralizationRule)/set_rule(Option<CentralizationRule>):
required: trueThe configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
- On success, responds with
UpdateCentralizationRuleForOrganizationOutputwith field(s):rule_arn(Option<String>):The Amazon Resource Name (ARN) of the updated organization centralization rule.
- On failure, responds with
SdkError<UpdateCentralizationRuleForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn update_telemetry_rule(&self) -> UpdateTelemetryRuleFluentBuilder
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: trueThe identifier (name or ARN) of the telemetry rule to update.
rule(TelemetryRule)/set_rule(Option<TelemetryRule>):
required: trueThe new configuration details for the telemetry rule.
- On success, responds with
UpdateTelemetryRuleOutputwith field(s):rule_arn(Option<String>):The Amazon Resource Name (ARN) of the updated telemetry rule.
- On failure, responds with
SdkError<UpdateTelemetryRuleError>
Source§impl Client
impl Client
Sourcepub fn update_telemetry_rule_for_organization(
&self,
) -> UpdateTelemetryRuleForOrganizationFluentBuilder
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: trueThe identifier (name or ARN) of the organization telemetry rule to update.
rule(TelemetryRule)/set_rule(Option<TelemetryRule>):
required: trueThe new configuration details for the organization telemetry rule, including resource type, telemetry type, and destination configuration.
- On success, responds with
UpdateTelemetryRuleForOrganizationOutputwith field(s):rule_arn(Option<String>):The Amazon Resource Name (ARN) of the updated organization telemetry rule.
- On failure, responds with
SdkError<UpdateTelemetryRuleForOrganizationError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
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_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);