Struct aws_sdk_xray::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AWS X-Ray
Client for invoking operations on AWS X-Ray. Each operation on AWS X-Ray is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_xray::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_xray::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_xray::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn batch_get_traces(&self) -> BatchGetTraces
pub fn batch_get_traces(&self) -> BatchGetTraces
Constructs a fluent builder for the BatchGetTraces
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
trace_ids(Vec<String>)
/set_trace_ids(Option<Vec<String>>)
:Specify the trace IDs of requests for which to retrieve segments.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
BatchGetTracesOutput
with field(s):traces(Option<Vec<Trace>>)
:Full traces for the specified requests.
unprocessed_trace_ids(Option<Vec<String>>)
:Trace IDs of requests that haven’t been processed.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<BatchGetTracesError>
sourcepub fn create_group(&self) -> CreateGroup
pub fn create_group(&self) -> CreateGroup
Constructs a fluent builder for the CreateGroup
operation.
- The fluent builder is configurable:
group_name(impl Into<String>)
/set_group_name(Option<String>)
:The case-sensitive name of the new group. Default is a reserved name and names must be unique.
filter_expression(impl Into<String>)
/set_filter_expression(Option<String>)
:The filter expression defining criteria by which to group traces.
insights_configuration(InsightsConfiguration)
/set_insights_configuration(Option<InsightsConfiguration>)
:The structure containing configurations related to insights.
-
The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
-
The NotifcationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.
-
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
-
Maximum number of user-applied tags per resource: 50
-
Maximum tag key length: 128 Unicode characters
-
Maximum tag value length: 256 Unicode characters
-
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
-
Tag keys and values are case sensitive.
-
Don’t use
aws:
as a prefix for keys; it’s reserved for Amazon Web Services use.
-
- On success, responds with
CreateGroupOutput
with field(s):group(Option<Group>)
:The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.
- On failure, responds with
SdkError<CreateGroupError>
sourcepub fn create_sampling_rule(&self) -> CreateSamplingRule
pub fn create_sampling_rule(&self) -> CreateSamplingRule
Constructs a fluent builder for the CreateSamplingRule
operation.
- The fluent builder is configurable:
sampling_rule(SamplingRule)
/set_sampling_rule(Option<SamplingRule>)
:The rule definition.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
-
Maximum number of user-applied tags per resource: 50
-
Maximum tag key length: 128 Unicode characters
-
Maximum tag value length: 256 Unicode characters
-
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
-
Tag keys and values are case sensitive.
-
Don’t use
aws:
as a prefix for keys; it’s reserved for Amazon Web Services use.
-
- On success, responds with
CreateSamplingRuleOutput
with field(s):sampling_rule_record(Option<SamplingRuleRecord>)
:The saved rule definition and metadata.
- On failure, responds with
SdkError<CreateSamplingRuleError>
sourcepub fn delete_group(&self) -> DeleteGroup
pub fn delete_group(&self) -> DeleteGroup
Constructs a fluent builder for the DeleteGroup
operation.
- The fluent builder is configurable:
group_name(impl Into<String>)
/set_group_name(Option<String>)
:The case-sensitive name of the group.
group_arn(impl Into<String>)
/set_group_arn(Option<String>)
:The ARN of the group that was generated on creation.
- On success, responds with
DeleteGroupOutput
- On failure, responds with
SdkError<DeleteGroupError>
sourcepub fn delete_sampling_rule(&self) -> DeleteSamplingRule
pub fn delete_sampling_rule(&self) -> DeleteSamplingRule
Constructs a fluent builder for the DeleteSamplingRule
operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the sampling rule. Specify a rule by either name or ARN, but not both.
rule_arn(impl Into<String>)
/set_rule_arn(Option<String>)
:The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
- On success, responds with
DeleteSamplingRuleOutput
with field(s):sampling_rule_record(Option<SamplingRuleRecord>)
:The deleted rule definition and metadata.
- On failure, responds with
SdkError<DeleteSamplingRuleError>
sourcepub fn get_encryption_config(&self) -> GetEncryptionConfig
pub fn get_encryption_config(&self) -> GetEncryptionConfig
Constructs a fluent builder for the GetEncryptionConfig
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetEncryptionConfigOutput
with field(s):encryption_config(Option<EncryptionConfig>)
:The encryption configuration document.
- On failure, responds with
SdkError<GetEncryptionConfigError>
sourcepub fn get_group(&self) -> GetGroup
pub fn get_group(&self) -> GetGroup
Constructs a fluent builder for the GetGroup
operation.
- The fluent builder is configurable:
group_name(impl Into<String>)
/set_group_name(Option<String>)
:The case-sensitive name of the group.
group_arn(impl Into<String>)
/set_group_arn(Option<String>)
:The ARN of the group that was generated on creation.
- On success, responds with
GetGroupOutput
with field(s):group(Option<Group>)
:The group that was requested. Contains the name of the group, the ARN of the group, the filter expression, and the insight configuration assigned to the group.
- On failure, responds with
SdkError<GetGroupError>
sourcepub fn get_groups(&self) -> GetGroups
pub fn get_groups(&self) -> GetGroups
Constructs a fluent builder for the GetGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
GetGroupsOutput
with field(s):groups(Option<Vec<GroupSummary>>)
:The collection of all active groups.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetGroupsError>
sourcepub fn get_insight(&self) -> GetInsight
pub fn get_insight(&self) -> GetInsight
Constructs a fluent builder for the GetInsight
operation.
- The fluent builder is configurable:
insight_id(impl Into<String>)
/set_insight_id(Option<String>)
:The insight’s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
- On success, responds with
GetInsightOutput
with field(s):insight(Option<Insight>)
:The summary information of an insight.
- On failure, responds with
SdkError<GetInsightError>
sourcepub fn get_insight_events(&self) -> GetInsightEvents
pub fn get_insight_events(&self) -> GetInsightEvents
Constructs a fluent builder for the GetInsightEvents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
insight_id(impl Into<String>)
/set_insight_id(Option<String>)
:The insight’s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
max_results(i32)
/set_max_results(Option<i32>)
:Used to retrieve at most the specified value of events.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Specify the pagination token returned by a previous request to retrieve the next page of events.
- On success, responds with
GetInsightEventsOutput
with field(s):insight_events(Option<Vec<InsightEvent>>)
:A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.
next_token(Option<String>)
:Use this token to retrieve the next page of insight events.
- On failure, responds with
SdkError<GetInsightEventsError>
sourcepub fn get_insight_impact_graph(&self) -> GetInsightImpactGraph
pub fn get_insight_impact_graph(&self) -> GetInsightImpactGraph
Constructs a fluent builder for the GetInsightImpactGraph
operation.
- The fluent builder is configurable:
insight_id(impl Into<String>)
/set_insight_id(Option<String>)
:The insight’s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can’t be more than 30 days old.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can’t be more than six hours.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Specify the pagination token returned by a previous request to retrieve the next page of results.
- On success, responds with
GetInsightImpactGraphOutput
with field(s):insight_id(Option<String>)
:The insight’s unique identifier.
start_time(Option<DateTime>)
:The provided start time.
end_time(Option<DateTime>)
:The provided end time.
service_graph_start_time(Option<DateTime>)
:The time, in Unix seconds, at which the service graph started.
service_graph_end_time(Option<DateTime>)
:The time, in Unix seconds, at which the service graph ended.
services(Option<Vec<InsightImpactGraphService>>)
:The Amazon Web Services instrumented services related to the insight.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetInsightImpactGraphError>
sourcepub fn get_insight_summaries(&self) -> GetInsightSummaries
pub fn get_insight_summaries(&self) -> GetInsightSummaries
Constructs a fluent builder for the GetInsightSummaries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
states(Vec<InsightState>)
/set_states(Option<Vec<InsightState>>)
:The list of insight states.
group_arn(impl Into<String>)
/set_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the group. Required if the GroupName isn’t provided.
group_name(impl Into<String>)
/set_group_name(Option<String>)
:The name of the group. Required if the GroupARN isn’t provided.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The beginning of the time frame in which the insights started. The start time can’t be more than 30 days old.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end of the time frame in which the insights ended. The end time can’t be more than 30 days old.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to display.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
GetInsightSummariesOutput
with field(s):insight_summaries(Option<Vec<InsightSummary>>)
:The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetInsightSummariesError>
sourcepub fn get_sampling_rules(&self) -> GetSamplingRules
pub fn get_sampling_rules(&self) -> GetSamplingRules
Constructs a fluent builder for the GetSamplingRules
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
GetSamplingRulesOutput
with field(s):sampling_rule_records(Option<Vec<SamplingRuleRecord>>)
:Rule definitions and metadata.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetSamplingRulesError>
sourcepub fn get_sampling_statistic_summaries(&self) -> GetSamplingStatisticSummaries
pub fn get_sampling_statistic_summaries(&self) -> GetSamplingStatisticSummaries
Constructs a fluent builder for the GetSamplingStatisticSummaries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
GetSamplingStatisticSummariesOutput
with field(s):sampling_statistic_summaries(Option<Vec<SamplingStatisticSummary>>)
:Information about the number of requests instrumented for each sampling rule.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetSamplingStatisticSummariesError>
sourcepub fn get_sampling_targets(&self) -> GetSamplingTargets
pub fn get_sampling_targets(&self) -> GetSamplingTargets
Constructs a fluent builder for the GetSamplingTargets
operation.
- The fluent builder is configurable:
sampling_statistics_documents(Vec<SamplingStatisticsDocument>)
/set_sampling_statistics_documents(Option<Vec<SamplingStatisticsDocument>>)
:Information about rules that the service is using to sample requests.
- On success, responds with
GetSamplingTargetsOutput
with field(s):sampling_target_documents(Option<Vec<SamplingTargetDocument>>)
:Updated rules that the service should use to sample requests.
last_rule_modification(Option<DateTime>)
:The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.
unprocessed_statistics(Option<Vec<UnprocessedStatistics>>)
:Information about SamplingStatisticsDocument that X-Ray could not process.
- On failure, responds with
SdkError<GetSamplingTargetsError>
sourcepub fn get_service_graph(&self) -> GetServiceGraph
pub fn get_service_graph(&self) -> GetServiceGraph
Constructs a fluent builder for the GetServiceGraph
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The start of the time frame for which to generate a graph.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end of the timeframe for which to generate a graph.
group_name(impl Into<String>)
/set_group_name(Option<String>)
:The name of a group based on which you want to generate a graph.
group_arn(impl Into<String>)
/set_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
GetServiceGraphOutput
with field(s):start_time(Option<DateTime>)
:The start of the time frame for which the graph was generated.
end_time(Option<DateTime>)
:The end of the time frame for which the graph was generated.
services(Option<Vec<Service>>)
:The services that have processed a traced request during the specified time frame.
contains_old_group_versions(bool)
:A flag indicating whether the group’s filter expression has been consistent, or if the returned service graph may show traces from an older version of the group’s filter expression.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetServiceGraphError>
sourcepub fn get_time_series_service_statistics(
&self
) -> GetTimeSeriesServiceStatistics
pub fn get_time_series_service_statistics(
&self
) -> GetTimeSeriesServiceStatistics
Constructs a fluent builder for the GetTimeSeriesServiceStatistics
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The start of the time frame for which to aggregate statistics.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end of the time frame for which to aggregate statistics.
group_name(impl Into<String>)
/set_group_name(Option<String>)
:The case-sensitive name of the group for which to pull statistics from.
group_arn(impl Into<String>)
/set_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the group for which to pull statistics from.
entity_selector_expression(impl Into<String>)
/set_entity_selector_expression(Option<String>)
:A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.
period(i32)
/set_period(Option<i32>)
:Aggregation period in seconds.
forecast_statistics(bool)
/set_forecast_statistics(Option<bool>)
:The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
GetTimeSeriesServiceStatisticsOutput
with field(s):time_series_service_statistics(Option<Vec<TimeSeriesServiceStatistics>>)
:The collection of statistics.
contains_old_group_versions(bool)
:A flag indicating whether or not a group’s filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group’s filter expression.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetTimeSeriesServiceStatisticsError>
sourcepub fn get_trace_graph(&self) -> GetTraceGraph
pub fn get_trace_graph(&self) -> GetTraceGraph
Constructs a fluent builder for the GetTraceGraph
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
trace_ids(Vec<String>)
/set_trace_ids(Option<Vec<String>>)
:Trace IDs of requests for which to generate a service graph.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Pagination token.
- On success, responds with
GetTraceGraphOutput
with field(s):services(Option<Vec<Service>>)
:The services that have processed one of the specified requests.
next_token(Option<String>)
:Pagination token.
- On failure, responds with
SdkError<GetTraceGraphError>
sourcepub fn get_trace_summaries(&self) -> GetTraceSummaries
pub fn get_trace_summaries(&self) -> GetTraceSummaries
Constructs a fluent builder for the GetTraceSummaries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The start of the time frame for which to retrieve traces.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end of the time frame for which to retrieve traces.
time_range_type(TimeRangeType)
/set_time_range_type(Option<TimeRangeType>)
:A parameter to indicate whether to query trace summaries by TraceId or Event time.
sampling(bool)
/set_sampling(Option<bool>)
:Set to
true
to get summaries for only a subset of available traces.sampling_strategy(SamplingStrategy)
/set_sampling_strategy(Option<SamplingStrategy>)
:A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
filter_expression(impl Into<String>)
/set_filter_expression(Option<String>)
:Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Specify the pagination token returned by a previous request to retrieve the next page of results.
- On success, responds with
GetTraceSummariesOutput
with field(s):trace_summaries(Option<Vec<TraceSummary>>)
:Trace IDs and annotations for traces that were found in the specified time frame.
approximate_time(Option<DateTime>)
:The start time of this page of results.
traces_processed_count(Option<i64>)
:The total number of traces processed, including traces that did not match the specified filter expression.
next_token(Option<String>)
:If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.
- On failure, responds with
SdkError<GetTraceSummariesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. If multiple pages of results are returned, use the
NextToken
value returned with the current page of results as the value of this parameter to get the next page of results.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.
next_token(Option<String>)
:A pagination token. If multiple pages of results are returned, use the
NextToken
value returned with the current page of results to get the next page of results.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn put_encryption_config(&self) -> PutEncryptionConfig
pub fn put_encryption_config(&self) -> PutEncryptionConfig
Constructs a fluent builder for the PutEncryptionConfig
operation.
- The fluent builder is configurable:
key_id(impl Into<String>)
/set_key_id(Option<String>)
:An Amazon Web Services KMS key in one of the following formats:
-
Alias - The name of the key. For example,
alias/MyKey
. -
Key ID - The KMS key ID of the key. For example,
ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
. Amazon Web Services X-Ray does not support asymmetric KMS keys. -
ARN - The full Amazon Resource Name of the key ID or alias. For example,
arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
. Use this format to specify a key in a different account.
Omit this key if you set
Type
toNONE
.-
r#type(EncryptionType)
/set_type(Option<EncryptionType>)
:The type of encryption. Set to
KMS
to use your own key for encryption. Set toNONE
for default encryption.
- On success, responds with
PutEncryptionConfigOutput
with field(s):encryption_config(Option<EncryptionConfig>)
:The new encryption configuration.
- On failure, responds with
SdkError<PutEncryptionConfigError>
sourcepub fn put_telemetry_records(&self) -> PutTelemetryRecords
pub fn put_telemetry_records(&self) -> PutTelemetryRecords
Constructs a fluent builder for the PutTelemetryRecords
operation.
- The fluent builder is configurable:
- On success, responds with
PutTelemetryRecordsOutput
- On failure, responds with
SdkError<PutTelemetryRecordsError>
sourcepub fn put_trace_segments(&self) -> PutTraceSegments
pub fn put_trace_segments(&self) -> PutTraceSegments
Constructs a fluent builder for the PutTraceSegments
operation.
- The fluent builder is configurable:
trace_segment_documents(Vec<String>)
/set_trace_segment_documents(Option<Vec<String>>)
:A string containing a JSON document defining one or more segments or subsegments.
- On success, responds with
PutTraceSegmentsOutput
with field(s):unprocessed_trace_segments(Option<Vec<UnprocessedTraceSegment>>)
:Segments that failed processing.
- On failure, responds with
SdkError<PutTraceSegmentsError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
-
Maximum number of user-applied tags per resource: 50
-
Maximum tag key length: 128 Unicode characters
-
Maximum tag value length: 256 Unicode characters
-
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
-
Tag keys and values are case sensitive.
-
Don’t use
aws:
as a prefix for keys; it’s reserved for Amazon Web Services use. You cannot edit or delete system tags.
-
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_group(&self) -> UpdateGroup
pub fn update_group(&self) -> UpdateGroup
Constructs a fluent builder for the UpdateGroup
operation.
- The fluent builder is configurable:
group_name(impl Into<String>)
/set_group_name(Option<String>)
:The case-sensitive name of the group.
group_arn(impl Into<String>)
/set_group_arn(Option<String>)
:The ARN that was generated upon creation.
filter_expression(impl Into<String>)
/set_filter_expression(Option<String>)
:The updated filter expression defining criteria by which to group traces.
insights_configuration(InsightsConfiguration)
/set_insights_configuration(Option<InsightsConfiguration>)
:The structure containing configurations related to insights.
-
The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
-
The NotifcationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.
-
- On success, responds with
UpdateGroupOutput
with field(s):group(Option<Group>)
:The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.
- On failure, responds with
SdkError<UpdateGroupError>
sourcepub fn update_sampling_rule(&self) -> UpdateSamplingRule
pub fn update_sampling_rule(&self) -> UpdateSamplingRule
Constructs a fluent builder for the UpdateSamplingRule
operation.
- The fluent builder is configurable:
sampling_rule_update(SamplingRuleUpdate)
/set_sampling_rule_update(Option<SamplingRuleUpdate>)
:The rule and fields to change.
- On success, responds with
UpdateSamplingRuleOutput
with field(s):sampling_rule_record(Option<SamplingRuleRecord>)
:The updated rule definition and metadata.
- On failure, responds with
SdkError<UpdateSamplingRuleError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more