Struct aws_sdk_applicationinsights::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon CloudWatch Application Insights
Client for invoking operations on Amazon CloudWatch Application Insights. Each operation on Amazon CloudWatch Application Insights 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_applicationinsights::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_applicationinsights::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 AddWorkload
operation has
a Client::add_workload
, 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.add_workload()
.resource_group_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 add_workload(&self) -> AddWorkloadFluentBuilder
pub fn add_workload(&self) -> AddWorkloadFluentBuilder
Constructs a fluent builder for the AddWorkload
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
workload_configuration(WorkloadConfiguration)
/set_workload_configuration(Option<WorkloadConfiguration>)
:
required: trueThe configuration settings of the workload. The value is the escaped JSON of the configuration.
- On success, responds with
AddWorkloadOutput
with field(s):workload_id(Option<String>)
:The ID of the workload.
workload_configuration(Option<WorkloadConfiguration>)
:The configuration settings of the workload. The value is the escaped JSON of the configuration.
- On failure, responds with
SdkError<AddWorkloadError>
source§impl Client
impl Client
sourcepub fn create_application(&self) -> CreateApplicationFluentBuilder
pub fn create_application(&self) -> CreateApplicationFluentBuilder
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: falseThe name of the resource group.
ops_center_enabled(bool)
/set_ops_center_enabled(Option<bool>)
:
required: falseWhen set to
true
, creates opsItems for any problems detected on an application.cwe_monitor_enabled(bool)
/set_cwe_monitor_enabled(Option<bool>)
:
required: falseIndicates whether Application Insights can listen to CloudWatch events for the application resources, such as
instance terminated
,failed deployment
, and others.ops_item_sns_topic_arn(impl Into<String>)
/set_ops_item_sns_topic_arn(Option<String>)
:
required: falseThe SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseList of tags to add to the application. tag key (
Key
) and an associated tag value (Value
). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.auto_config_enabled(bool)
/set_auto_config_enabled(Option<bool>)
:
required: falseIndicates whether Application Insights automatically configures unmonitored resources in the resource group.
auto_create(bool)
/set_auto_create(Option<bool>)
:
required: falseConfigures all of the resources in the resource group by applying the recommended configurations.
grouping_type(GroupingType)
/set_grouping_type(Option<GroupingType>)
:
required: falseApplication Insights can create applications based on a resource group or on an account. To create an account-based application using all of the resources in the account, set this parameter to
ACCOUNT_BASED
.attach_missing_permission(bool)
/set_attach_missing_permission(Option<bool>)
:
required: falseIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
- On success, responds with
CreateApplicationOutput
with field(s):application_info(Option<ApplicationInfo>)
:Information about the application.
- On failure, responds with
SdkError<CreateApplicationError>
source§impl Client
impl Client
sourcepub fn create_component(&self) -> CreateComponentFluentBuilder
pub fn create_component(&self) -> CreateComponentFluentBuilder
Constructs a fluent builder for the CreateComponent
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
resource_list(impl Into<String>)
/set_resource_list(Option<Vec::<String>>)
:
required: trueThe list of resource ARNs that belong to the component.
- On success, responds with
CreateComponentOutput
- On failure, responds with
SdkError<CreateComponentError>
source§impl Client
impl Client
sourcepub fn create_log_pattern(&self) -> CreateLogPatternFluentBuilder
pub fn create_log_pattern(&self) -> CreateLogPatternFluentBuilder
Constructs a fluent builder for the CreateLogPattern
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
pattern_set_name(impl Into<String>)
/set_pattern_set_name(Option<String>)
:
required: trueThe name of the log pattern set.
pattern_name(impl Into<String>)
/set_pattern_name(Option<String>)
:
required: trueThe name of the log pattern.
pattern(impl Into<String>)
/set_pattern(Option<String>)
:
required: trueThe log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
rank(i32)
/set_rank(Option<i32>)
:
required: trueRank of the log pattern. Must be a value between
1
and1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank1
will be the first to get matched to a log line. A pattern of rank1,000,000
will be last to get matched. When you configure custom log patterns from the console, aLow
severity pattern translates to a750,000
rank. AMedium
severity pattern translates to a500,000
rank. And aHigh
severity pattern translates to a250,000
rank. Rank values less than1
or greater than1,000,000
are reserved for AWS-provided patterns.
- On success, responds with
CreateLogPatternOutput
with field(s):log_pattern(Option<LogPattern>)
:The successfully created log pattern.
resource_group_name(Option<String>)
:The name of the resource group.
- On failure, responds with
SdkError<CreateLogPatternError>
source§impl Client
impl Client
sourcepub fn delete_application(&self) -> DeleteApplicationFluentBuilder
pub fn delete_application(&self) -> DeleteApplicationFluentBuilder
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
source§impl Client
impl Client
sourcepub fn delete_component(&self) -> DeleteComponentFluentBuilder
pub fn delete_component(&self) -> DeleteComponentFluentBuilder
Constructs a fluent builder for the DeleteComponent
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
- On success, responds with
DeleteComponentOutput
- On failure, responds with
SdkError<DeleteComponentError>
source§impl Client
impl Client
sourcepub fn delete_log_pattern(&self) -> DeleteLogPatternFluentBuilder
pub fn delete_log_pattern(&self) -> DeleteLogPatternFluentBuilder
Constructs a fluent builder for the DeleteLogPattern
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
pattern_set_name(impl Into<String>)
/set_pattern_set_name(Option<String>)
:
required: trueThe name of the log pattern set.
pattern_name(impl Into<String>)
/set_pattern_name(Option<String>)
:
required: trueThe name of the log pattern.
- On success, responds with
DeleteLogPatternOutput
- On failure, responds with
SdkError<DeleteLogPatternError>
source§impl Client
impl Client
sourcepub fn describe_application(&self) -> DescribeApplicationFluentBuilder
pub fn describe_application(&self) -> DescribeApplicationFluentBuilder
Constructs a fluent builder for the DescribeApplication
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
DescribeApplicationOutput
with field(s):application_info(Option<ApplicationInfo>)
:Information about the application.
- On failure, responds with
SdkError<DescribeApplicationError>
source§impl Client
impl Client
sourcepub fn describe_component(&self) -> DescribeComponentFluentBuilder
pub fn describe_component(&self) -> DescribeComponentFluentBuilder
Constructs a fluent builder for the DescribeComponent
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
DescribeComponentOutput
with field(s):application_component(Option<ApplicationComponent>)
:Describes a standalone resource or similarly grouped resources that the application is made up of.
resource_list(Option<Vec::<String>>)
:The list of resource ARNs that belong to the component.
- On failure, responds with
SdkError<DescribeComponentError>
source§impl Client
impl Client
sourcepub fn describe_component_configuration(
&self
) -> DescribeComponentConfigurationFluentBuilder
pub fn describe_component_configuration( &self ) -> DescribeComponentConfigurationFluentBuilder
Constructs a fluent builder for the DescribeComponentConfiguration
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
DescribeComponentConfigurationOutput
with field(s):monitor(Option<bool>)
:Indicates whether the application component is monitored.
tier(Option<Tier>)
:The tier of the application component. Supported tiers include
DOT_NET_CORE
,DOT_NET_WORKER
,DOT_NET_WEB
,SQL_SERVER
, andDEFAULT
component_configuration(Option<String>)
:The configuration settings of the component. The value is the escaped JSON of the configuration.
- On failure, responds with
SdkError<DescribeComponentConfigurationError>
source§impl Client
impl Client
sourcepub fn describe_component_configuration_recommendation(
&self
) -> DescribeComponentConfigurationRecommendationFluentBuilder
pub fn describe_component_configuration_recommendation( &self ) -> DescribeComponentConfigurationRecommendationFluentBuilder
Constructs a fluent builder for the DescribeComponentConfigurationRecommendation
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
tier(Tier)
/set_tier(Option<Tier>)
:
required: trueThe tier of the application component.
workload_name(impl Into<String>)
/set_workload_name(Option<String>)
:
required: falseThe name of the workload.
recommendation_type(RecommendationType)
/set_recommendation_type(Option<RecommendationType>)
:
required: falseThe recommended configuration type.
- On success, responds with
DescribeComponentConfigurationRecommendationOutput
with field(s):component_configuration(Option<String>)
:The recommended configuration settings of the component. The value is the escaped JSON of the configuration.
- On failure, responds with
SdkError<DescribeComponentConfigurationRecommendationError>
source§impl Client
impl Client
sourcepub fn describe_log_pattern(&self) -> DescribeLogPatternFluentBuilder
pub fn describe_log_pattern(&self) -> DescribeLogPatternFluentBuilder
Constructs a fluent builder for the DescribeLogPattern
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
pattern_set_name(impl Into<String>)
/set_pattern_set_name(Option<String>)
:
required: trueThe name of the log pattern set.
pattern_name(impl Into<String>)
/set_pattern_name(Option<String>)
:
required: trueThe name of the log pattern.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
DescribeLogPatternOutput
with field(s):resource_group_name(Option<String>)
:The name of the resource group.
account_id(Option<String>)
:The AWS account ID for the resource group owner.
log_pattern(Option<LogPattern>)
:The successfully created log pattern.
- On failure, responds with
SdkError<DescribeLogPatternError>
source§impl Client
impl Client
sourcepub fn describe_observation(&self) -> DescribeObservationFluentBuilder
pub fn describe_observation(&self) -> DescribeObservationFluentBuilder
Constructs a fluent builder for the DescribeObservation
operation.
- The fluent builder is configurable:
observation_id(impl Into<String>)
/set_observation_id(Option<String>)
:
required: trueThe ID of the observation.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
DescribeObservationOutput
with field(s):observation(Option<Observation>)
:Information about the observation.
- On failure, responds with
SdkError<DescribeObservationError>
source§impl Client
impl Client
sourcepub fn describe_problem(&self) -> DescribeProblemFluentBuilder
pub fn describe_problem(&self) -> DescribeProblemFluentBuilder
Constructs a fluent builder for the DescribeProblem
operation.
- The fluent builder is configurable:
problem_id(impl Into<String>)
/set_problem_id(Option<String>)
:
required: trueThe ID of the problem.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the owner of the resource group affected by the problem.
- On success, responds with
DescribeProblemOutput
with field(s):problem(Option<Problem>)
:Information about the problem.
- On failure, responds with
SdkError<DescribeProblemError>
source§impl Client
impl Client
sourcepub fn describe_problem_observations(
&self
) -> DescribeProblemObservationsFluentBuilder
pub fn describe_problem_observations( &self ) -> DescribeProblemObservationsFluentBuilder
Constructs a fluent builder for the DescribeProblemObservations
operation.
- The fluent builder is configurable:
problem_id(impl Into<String>)
/set_problem_id(Option<String>)
:
required: trueThe ID of the problem.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
DescribeProblemObservationsOutput
with field(s):related_observations(Option<RelatedObservations>)
:Observations related to the problem.
- On failure, responds with
SdkError<DescribeProblemObservationsError>
source§impl Client
impl Client
sourcepub fn describe_workload(&self) -> DescribeWorkloadFluentBuilder
pub fn describe_workload(&self) -> DescribeWorkloadFluentBuilder
Constructs a fluent builder for the DescribeWorkload
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:
required: trueThe ID of the workload.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the workload owner.
- On success, responds with
DescribeWorkloadOutput
with field(s):workload_id(Option<String>)
:The ID of the workload.
workload_remarks(Option<String>)
:If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
workload_configuration(Option<WorkloadConfiguration>)
:The configuration settings of the workload. The value is the escaped JSON of the configuration.
- On failure, responds with
SdkError<DescribeWorkloadError>
source§impl Client
impl Client
sourcepub fn list_applications(&self) -> ListApplicationsFluentBuilder
pub fn list_applications(&self) -> ListApplicationsFluentBuilder
Constructs a fluent builder for the ListApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
ListApplicationsOutput
with field(s):application_info_list(Option<Vec::<ApplicationInfo>>)
:The list of applications.
next_token(Option<String>)
:The token used to retrieve the next page of results. This value is
null
when there are no more results to return.
- On failure, responds with
SdkError<ListApplicationsError>
source§impl Client
impl Client
sourcepub fn list_components(&self) -> ListComponentsFluentBuilder
pub fn list_components(&self) -> ListComponentsFluentBuilder
Constructs a fluent builder for the ListComponents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
ListComponentsOutput
with field(s):application_component_list(Option<Vec::<ApplicationComponent>>)
:The list of application components.
next_token(Option<String>)
:The token to request the next page of results.
- On failure, responds with
SdkError<ListComponentsError>
source§impl Client
impl Client
sourcepub fn list_configuration_history(
&self
) -> ListConfigurationHistoryFluentBuilder
pub fn list_configuration_history( &self ) -> ListConfigurationHistoryFluentBuilder
Constructs a fluent builder for the ListConfigurationHistory
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: falseResource group to which the application belongs.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe start time of the event.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe end time of the event.
event_status(ConfigurationEventStatus)
/set_event_status(Option<ConfigurationEventStatus>)
:
required: falseThe status of the configuration update event. Possible values include INFO, WARN, and ERROR.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results returned by
ListConfigurationHistory
in paginated output. When this parameter is used,ListConfigurationHistory
returns onlyMaxResults
in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherListConfigurationHistory
request with the returnedNextToken
value. If this parameter is not used, thenListConfigurationHistory
returns all results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
NextToken
value returned from a previous paginatedListConfigurationHistory
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
ListConfigurationHistoryOutput
with field(s):event_list(Option<Vec::<ConfigurationEvent>>)
:The list of configuration events and their corresponding details.
next_token(Option<String>)
:The
NextToken
value to include in a futureListConfigurationHistory
request. When the results of aListConfigurationHistory
request exceedMaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
- On failure, responds with
SdkError<ListConfigurationHistoryError>
source§impl Client
impl Client
sourcepub fn list_log_pattern_sets(&self) -> ListLogPatternSetsFluentBuilder
pub fn list_log_pattern_sets(&self) -> ListLogPatternSetsFluentBuilder
Constructs a fluent builder for the ListLogPatternSets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
ListLogPatternSetsOutput
with field(s):resource_group_name(Option<String>)
:The name of the resource group.
account_id(Option<String>)
:The AWS account ID for the resource group owner.
log_pattern_sets(Option<Vec::<String>>)
:The list of log pattern sets.
next_token(Option<String>)
:The token used to retrieve the next page of results. This value is
null
when there are no more results to return.
- On failure, responds with
SdkError<ListLogPatternSetsError>
source§impl Client
impl Client
sourcepub fn list_log_patterns(&self) -> ListLogPatternsFluentBuilder
pub fn list_log_patterns(&self) -> ListLogPatternsFluentBuilder
Constructs a fluent builder for the ListLogPatterns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
pattern_set_name(impl Into<String>)
/set_pattern_set_name(Option<String>)
:
required: falseThe name of the log pattern set.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
- On success, responds with
ListLogPatternsOutput
with field(s):resource_group_name(Option<String>)
:The name of the resource group.
account_id(Option<String>)
:The AWS account ID for the resource group owner.
log_patterns(Option<Vec::<LogPattern>>)
:The list of log patterns.
next_token(Option<String>)
:The token used to retrieve the next page of results. This value is
null
when there are no more results to return.
- On failure, responds with
SdkError<ListLogPatternsError>
source§impl Client
impl Client
sourcepub fn list_problems(&self) -> ListProblemsFluentBuilder
pub fn list_problems(&self) -> ListProblemsFluentBuilder
Constructs a fluent builder for the ListProblems
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID for the resource group owner.
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: falseThe name of the resource group.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe time when the problem was detected, in epoch seconds. If you don’t specify a time frame for the request, problems within the past seven days are returned.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: falseThe name of the component.
visibility(Visibility)
/set_visibility(Option<Visibility>)
:
required: falseSpecifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.
- On success, responds with
ListProblemsOutput
with field(s):problem_list(Option<Vec::<Problem>>)
:The list of problems.
next_token(Option<String>)
:The token used to retrieve the next page of results. This value is
null
when there are no more results to return.resource_group_name(Option<String>)
:The name of the resource group.
account_id(Option<String>)
:The AWS account ID for the resource group owner.
- On failure, responds with
SdkError<ListProblemsError>
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 application that you want to retrieve tag information for.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:An array that lists all the tags that are associated with the application. Each tag consists of a required tag key (
Key
) and an associated tag value (Value
).
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_workloads(&self) -> ListWorkloadsFluentBuilder
pub fn list_workloads(&self) -> ListWorkloadsFluentBuilder
Constructs a fluent builder for the ListWorkloads
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: falseThe AWS account ID of the owner of the workload.
- On success, responds with
ListWorkloadsOutput
with field(s):workload_list(Option<Vec::<Workload>>)
:The list of workloads.
next_token(Option<String>)
:The token to request the next page of results.
- On failure, responds with
SdkError<ListWorkloadsError>
source§impl Client
impl Client
sourcepub fn remove_workload(&self) -> RemoveWorkloadFluentBuilder
pub fn remove_workload(&self) -> RemoveWorkloadFluentBuilder
Constructs a fluent builder for the RemoveWorkload
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:
required: trueThe ID of the workload.
- On success, responds with
RemoveWorkloadOutput
- On failure, responds with
SdkError<RemoveWorkloadError>
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 application that you want to add one or more tags to.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA list of tags that to add to the application. A tag consists of a required tag key (
Key
) and an associated tag value (Value
). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
- 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 application that you want to remove one or more tags from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
To remove more than one tag from the application, append the
TagKeys
parameter and argument for each additional tag to remove, separated by an ampersand.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_application(&self) -> UpdateApplicationFluentBuilder
pub fn update_application(&self) -> UpdateApplicationFluentBuilder
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
ops_center_enabled(bool)
/set_ops_center_enabled(Option<bool>)
:
required: falseWhen set to
true
, creates opsItems for any problems detected on an application.cwe_monitor_enabled(bool)
/set_cwe_monitor_enabled(Option<bool>)
:
required: falseIndicates whether Application Insights can listen to CloudWatch events for the application resources, such as
instance terminated
,failed deployment
, and others.ops_item_sns_topic_arn(impl Into<String>)
/set_ops_item_sns_topic_arn(Option<String>)
:
required: falseThe SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
remove_sns_topic(bool)
/set_remove_sns_topic(Option<bool>)
:
required: falseDisassociates the SNS topic from the opsItem created for detected problems.
auto_config_enabled(bool)
/set_auto_config_enabled(Option<bool>)
:
required: falseTurns auto-configuration on or off.
attach_missing_permission(bool)
/set_attach_missing_permission(Option<bool>)
:
required: falseIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
- On success, responds with
UpdateApplicationOutput
with field(s):application_info(Option<ApplicationInfo>)
:Information about the application.
- On failure, responds with
SdkError<UpdateApplicationError>
source§impl Client
impl Client
sourcepub fn update_component(&self) -> UpdateComponentFluentBuilder
pub fn update_component(&self) -> UpdateComponentFluentBuilder
Constructs a fluent builder for the UpdateComponent
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
new_component_name(impl Into<String>)
/set_new_component_name(Option<String>)
:
required: falseThe new name of the component.
resource_list(impl Into<String>)
/set_resource_list(Option<Vec::<String>>)
:
required: falseThe list of resource ARNs that belong to the component.
- On success, responds with
UpdateComponentOutput
- On failure, responds with
SdkError<UpdateComponentError>
source§impl Client
impl Client
sourcepub fn update_component_configuration(
&self
) -> UpdateComponentConfigurationFluentBuilder
pub fn update_component_configuration( &self ) -> UpdateComponentConfigurationFluentBuilder
Constructs a fluent builder for the UpdateComponentConfiguration
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
monitor(bool)
/set_monitor(Option<bool>)
:
required: falseIndicates whether the application component is monitored.
tier(Tier)
/set_tier(Option<Tier>)
:
required: falseThe tier of the application component.
component_configuration(impl Into<String>)
/set_component_configuration(Option<String>)
:
required: falseThe configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to
DescribeComponentConfigurationRecommendation
to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration.auto_config_enabled(bool)
/set_auto_config_enabled(Option<bool>)
:
required: falseAutomatically configures the component by applying the recommended configurations.
- On success, responds with
UpdateComponentConfigurationOutput
- On failure, responds with
SdkError<UpdateComponentConfigurationError>
source§impl Client
impl Client
sourcepub fn update_log_pattern(&self) -> UpdateLogPatternFluentBuilder
pub fn update_log_pattern(&self) -> UpdateLogPatternFluentBuilder
Constructs a fluent builder for the UpdateLogPattern
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
pattern_set_name(impl Into<String>)
/set_pattern_set_name(Option<String>)
:
required: trueThe name of the log pattern set.
pattern_name(impl Into<String>)
/set_pattern_name(Option<String>)
:
required: trueThe name of the log pattern.
pattern(impl Into<String>)
/set_pattern(Option<String>)
:
required: falseThe log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
rank(i32)
/set_rank(Option<i32>)
:
required: falseRank of the log pattern. Must be a value between
1
and1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank1
will be the first to get matched to a log line. A pattern of rank1,000,000
will be last to get matched. When you configure custom log patterns from the console, aLow
severity pattern translates to a750,000
rank. AMedium
severity pattern translates to a500,000
rank. And aHigh
severity pattern translates to a250,000
rank. Rank values less than1
or greater than1,000,000
are reserved for AWS-provided patterns.
- On success, responds with
UpdateLogPatternOutput
with field(s):resource_group_name(Option<String>)
:The name of the resource group.
log_pattern(Option<LogPattern>)
:The successfully created log pattern.
- On failure, responds with
SdkError<UpdateLogPatternError>
source§impl Client
impl Client
sourcepub fn update_problem(&self) -> UpdateProblemFluentBuilder
pub fn update_problem(&self) -> UpdateProblemFluentBuilder
Constructs a fluent builder for the UpdateProblem
operation.
- The fluent builder is configurable:
problem_id(impl Into<String>)
/set_problem_id(Option<String>)
:
required: trueThe ID of the problem.
update_status(UpdateStatus)
/set_update_status(Option<UpdateStatus>)
:
required: falseThe status of the problem. Arguments can be passed for only problems that show a status of
RECOVERING
.visibility(Visibility)
/set_visibility(Option<Visibility>)
:
required: falseThe visibility of a problem. When you pass a value of
IGNORED
, the problem is removed from the default view, and all notifications for the problem are suspended. WhenVISIBLE
is passed, theIGNORED
action is reversed.
- On success, responds with
UpdateProblemOutput
- On failure, responds with
SdkError<UpdateProblemError>
source§impl Client
impl Client
sourcepub fn update_workload(&self) -> UpdateWorkloadFluentBuilder
pub fn update_workload(&self) -> UpdateWorkloadFluentBuilder
Constructs a fluent builder for the UpdateWorkload
operation.
- The fluent builder is configurable:
resource_group_name(impl Into<String>)
/set_resource_group_name(Option<String>)
:
required: trueThe name of the resource group.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: trueThe name of the component.
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:
required: falseThe ID of the workload.
workload_configuration(WorkloadConfiguration)
/set_workload_configuration(Option<WorkloadConfiguration>)
:
required: trueThe configuration settings of the workload. The value is the escaped JSON of the configuration.
- On success, responds with
UpdateWorkloadOutput
with field(s):workload_id(Option<String>)
:The ID of the workload.
workload_configuration(Option<WorkloadConfiguration>)
:The configuration settings of the workload. The value is the escaped JSON of the configuration.
- On failure, responds with
SdkError<UpdateWorkloadError>
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_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is 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_config
is missing an async sleep implementation. If you experience this panic, set thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo 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> 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 more